ウォッチ削除API

ウォッチをWatcherから削除します。

リクエスト

DELETE _watcher/watch/<watch_id>

前提条件

  • このAPIを使用するには、manage_watcherクラスター権限が必要です。詳細については、セキュリティ権限を参照してください。

説明

ウォッチが削除されると、.watchesインデックス内のウォッチを表すドキュメントは消失し、再度実行されることはありません。

ウォッチを削除しても、このウォッチに関連するウォッチ実行記録はウォッチ履歴から削除されないことに注意してください。

ウォッチの削除はこのAPIを通じてのみ行う必要があります。Elasticsearch DELETE Document APIを使用して.watchesインデックスから直接ウォッチを削除しないでください。Elasticsearchのセキュリティ機能が有効になっている場合、.watchesインデックスに対してwrite権限が誰にも付与されていないことを確認してください。

パスパラメータ

  • <watch_id>
  • (必須、文字列)ウォッチの識別子。

以下の例は、my-watch IDを持つウォッチを削除します:

Python

  1. resp = client.watcher.delete_watch(
  2. id="my_watch",
  3. )
  4. print(resp)

Ruby

  1. response = client.watcher.delete_watch(
  2. id: 'my_watch'
  3. )
  4. puts response

Js

  1. const response = await client.watcher.deleteWatch({
  2. id: "my_watch",
  3. });
  4. console.log(response);

コンソール

  1. DELETE _watcher/watch/my_watch

レスポンス:

コンソール-結果

  1. {
  2. "found": true,
  3. "_id": "my_watch",
  4. "_version": 2
  5. }