› › ›

API остановки трансформаций

Останавливает одну или несколько трансформаций.

Запрос

POST _transform/<transform_id>/_stop

POST _transform/<transform_id1>,<transform_id2>/_stop

POST _transform/_all/_stop

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

Требуется привилегия кластера manage_transform. Эта привилегия включена в встроенную роль transform_admin.

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

<transform_id>: (Обязательный, строка) Идентификатор трансформации. Чтобы остановить несколько трансформаций, используйте список, разделенный запятыми, или выражение с подстановкой. Чтобы остановить все трансформации, используйте _all или * в качестве идентификатора.

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

allow_no_match

(Необязательный, логический) Указывает, что делать, когда запрос:

Содержит подстановку и нет соответствующих трансформаций.
Содержит строку _all или нет идентификаторов, и нет совпадений.
Содержит выражения подстановки, и есть только частичные совпадения.

Значение по умолчанию — true, которое возвращает сообщение об успешном подтверждении, если нет совпадений. Если есть только частичные совпадения, API останавливает соответствующие трансформации. Например, если запрос содержит test-id1*,test-id2* в качестве идентификаторов, а трансформаций, соответствующих test-id2*, нет, API тем не менее останавливает трансформации, соответствующие test-id1*.

Если этот параметр равен false, запрос возвращает код состояния 404, если нет совпадений или есть только частичные совпадения.

force

(Необязательный, логический) Установите в true, чтобы остановить неисправную трансформацию или принудительно остановить трансформацию, которая не отреагировала на первоначальный запрос об остановке.

timeout

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

wait_for_checkpoint

(Необязательный, логический) Если установлено в true, трансформация не полностью остановится, пока не будет завершён текущий контрольный пункт. Если установлено в false, трансформация останавливается как можно скорее. По умолчанию значение false.

wait_for_completion

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

Коды ответов

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

Примеры

POST _transform/ecommerce_transform/_stop

При остановке трансформации вы получаете следующие результаты:

{
  "acknowledged" : true
}

© 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/stop-transform.html