Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›API управления жизненным циклом индексов

API остановки управления жизненным циклом индексов

Новая справка по API

Для получения самых актуальных данных об API обратитесь к API управления жизненным циклом индексов.

Остановите плагин управления жизненным циклом индексов (ILM).

Запрос

POST /_ilm/stop

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

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

Описание

Останавливает все операции управления жизненным циклом и останавливает плагин ILM. Это полезно, когда вы проводите техническое обслуживание кластера и хотите предотвратить выполнение ILM каких-либо действий над вашими индексами.

API возвращает результат сразу после подтверждения запроса на остановку, но плагин может продолжить работу до завершения текущих операций и безопасной остановки плагина. Используйте API получения статуса ILM, чтобы проверить, работает ли ILM.

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

master_timeout
(Необязательно, единицы измерения времени) Период ожидания для узла-мастера. Если узел-мастер недоступен до истечения таймаута, запрос завершается с ошибкой. По умолчанию 30s. Также может быть установлен в значение -1, чтобы указать, что запрос никогда не должен зависать.
timeout
(Необязательно, единицы измерения времени) Период ожидания ответа от всех соответствующих узлов кластера после обновления метаданных кластера. Если ответ не получен до истечения таймаута, обновление метаданных кластера все равно применяется, но ответ укажет, что он не был полностью подтвержден. По умолчанию 30s. Также может быть установлен в значение -1, чтобы указать, что запрос никогда не должен зависать.

Примеры

Следующий пример останавливает плагин ILM.

resp = client.ilm.stop()
print(resp)
response = client.ilm.stop
puts response
const response = await client.ilm.stop();
console.log(response);
POST _ilm/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/ilm-stop.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API