› › ›

停用监视器 API

编辑

停用监视器 API

编辑

监视器可以是活动的或不活动的。此 API 使您可以停用当前活动的监视器。

请求

编辑

PUT _watcher/watch/<watch_id>/_deactivate

先决条件

编辑

您必须具有 manage_watcher 集群特权才能使用此 API。有关更多信息，请参阅安全特权。

路径参数

编辑

<watch_id>: (必需，字符串) 监视器的标识符。

示例

编辑

当您调用获取监视器 API时，活动监视器的状态会与监视器定义一起返回。

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

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 调用来停用监视器

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

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
  }
}

« 激活监视器 API 删除监视器 API »