› › ›

API остановки задач агрегации

Останавливает существующую запущенную задачу агрегации.

Эта функция находится в техническом предварительном просмотре и может быть изменена или удалена в будущих выпусках. Elastic будет работать над устранением любых проблем, но функции в техническом предварительном просмотре не подпадают под SLA поддержки официальных функций GA.

Запрос

POST _rollup/job/<job_id>/_stop

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

Если функции безопасности Elasticsearch включены, необходимо иметь manage или manage_rollup права доступа к кластеру, чтобы использовать этот API. Дополнительные сведения см. в разделе Права доступа к безопасности.

Описание

Если вы попытаетесь остановить задачу, которая не существует, произойдет исключение. Если вы попытаетесь остановить уже остановленную задачу, ничего не произойдёт.

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

<job_id>: (Обязательный, строка) Идентификатор задачи агрегации.

Параметры запроса

timeout: (Необязательный, TimeValue) Если wait_for_completion является true, API блокируется (максимально) на указанный срок ожидания остановки задачи. Если прошло более timeout времени, API возвращает исключение таймаута. По умолчанию 30s.

Даже если возникает исключение таймаута, запрос на остановку всё ещё обрабатывается и, в конечном итоге, переводит задачу в состояние STOPPED. Таймаут означает просто, что сам вызов API завис, ожидая изменения статуса.
wait_for_completion: (Необязательный, Булево) Если установлено в значение true, API блокируется до полного остановления состояния индексатора. Если установлено в значение false, API возвращается немедленно, а индексатор останавливается асинхронно в фоновом режиме. По умолчанию false.

Коды ответов

404 (Отсутствующие ресурсы): Этот код указывает на отсутствие ресурсов, соответствующих запросу. Это происходит, если вы пытаетесь остановить задачу, которая не существует.

Примеры

Поскольку только остановленную задачу можно удалить, может быть полезно заблокировать API до полного остановки индексатора. Это достигается с помощью параметра wait_for_completion, и необязательно параметра timeout:

POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s

Параметр блокирует возврат вызова API до тех пор, пока задача не перейдет в состояние STOPPED или не истечёт указанное время. Если указанное время истечёт, а задача не перейдёт в состояние STOPPED, будет выброшено исключение таймаута.

© 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/7.17/rollup-stop-job.html