› › ›

API деактивации наблюдения

Наблюдение может быть активным или неактивным. Этот API позволяет деактивировать активное наблюдение.

Запрос

PUT _watcher/watch/<watch_id>/_deactivate

Предварительные требования

Для использования этого API необходимо иметь manage_watcher разрешения кластера. Более подробную информацию см. в разделе Разрешения безопасности.

Параметры пути

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

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/watcher-api-deactivate-watch.html