ウォッチの無効化（Deactivate watch）

ウォッチ API の無効化

ウォッチは アクティブまたは非アクティブ のいずれかです。この API を使用すると、現在アクティブなウォッチを無効化できます。

リクエスト

PUT _watcher/watch/<watch_id>/_deactivate

前提条件

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

パスパラメータ

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

例

アクティブなウォッチの状態は、ウォッチ取得 API を呼び出すと、ウォッチ定義と共に返されます。

Python

resp = client.watcher.get_watch(
   id="my_watch",
)
print(resp)

Js

const response = await client.watcher.getWatch({
  id: "my_watch",
});
console.log(response);

コンソール

GET _watcher/watch/my_watch

コンソール-結果

{
  "found": true,
  "_id": "my_watch",
  "_version": 1,
  "_seq_no": 0,
  "_primary_term": 1,
  "status": {
   "state" : {
   "active" : true,
   "timestamp" : "2015-08-20T12:21:32.734Z"
   },
   "actions": ...,
   "version": 1
  },
  "watch": ...
}

次の API 呼び出しを実行することで、ウォッチを無効化できます:

Python

resp = client.watcher.deactivate_watch(
   watch_id="my_watch",
)
print(resp)

Js

const response = await client.watcher.deactivateWatch({
  watch_id: "my_watch",
});
console.log(response);

コンソール

PUT _watcher/watch/my_watch/_deactivate

ウォッチの新しい状態は、その全体の状態の一部として返されます:

コンソール-結果

{
  "status": {
   "state" : {
   "active" : false,
   "timestamp" : "2015-09-04T08:39:46.816Z"
   },
   "actions": ...,
   "version": 1
  }
}