› › ›

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, этот код указывает, что ресурсов, соответствующих запросу, нет или есть только частичные соответствия запросу.

Примеры

resp = client.transform.stop_transform(
    transform_id="ecommerce_transform",
)
print(resp)

response = client.transform.stop_transform(
  transform_id: 'ecommerce_transform'
)
puts response

const response = await client.transform.stopTransform({
  transform_id: "ecommerce_transform",
});
console.log(response);

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