› › ›

API запроса к смотрителям

Возвращает все зарегистрированные смотрителей.

Запрос

GET /_watcher/_query/watches

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

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

Возвращает всех смотрителей с постраничной навигацией и, по желанию, с фильтрацией по запросу.

Данный API поддерживает следующие поля:

Имя	Обязательно	По умолчанию	Описание
`from`	нет	0	Смещение от первого результата для извлечения. Должно быть неотрицательным.
`size`	нет	10	Количество результатов для возврата. Должно быть неотрицательным.
`query`	нет	null	Необязательный фильтр запроса для возвращаемых смотрителей.
`sort`	нет	null	Необязательное определение сортировки.
`search_after`	нет	null	Необязательный параметр search After для постраничной навигации с использованием значений сортировки последнего результата.

Обратите внимание, что только поля _id и metadata.* могут быть использованы для поиска или сортировки.

Этот API возвращает следующие поля верхнего уровня:

count: Общее количество найденных смотрителей.
watches: Список смотрителей, основанный на параметрах тела запроса from, size или search_after.

Примеры

Следующий пример отображает все сохраненные смотрители:

resp = client.watcher.query_watches()
print(resp)

const response = await client.watcher.queryWatches();
console.log(response);

GET /_watcher/_query/watches

Ответ:

{
    "count": 1,
    "watches": [
        {
            "_id": "my_watch",
            "watch": {
                "trigger": {
                    "schedule": {
                        "hourly": {
                            "minute": [
                                0,
                                5
                            ]
                        }
                    }
                },
                "input": {
                    "simple": {
                        "payload": {
                            "send": "yes"
                        }
                    }
                },
                "condition": {
                    "always": {}
                },
                "actions": {
                    "test_index": {
                        "index": {
                            "index": "test"
                        }
                    }
                }
            },
            "status": {
                "state": {
                    "active": true,
                    "timestamp": "2015-05-26T18:21:08.630Z"
                },
                "actions": {
                    "test_index": {
                        "ack": {
                            "timestamp": "2015-05-26T18:21:08.630Z",
                            "state": "awaits_successful_execution"
                        }
                    }
                },
                "version": -1
            },
            "_seq_no": 0,
            "_primary_term": 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-query-watches.html