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

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

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

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

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

Вы можете начать или остановить ILM с помощью API запуска ILM и остановки ILM.

Запрос

GET /_ilm/status

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

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

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

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

Тело ответа

operation_mode

(строка) Текущий режим работы ILM.

Возможные значения для operation_mode
RUNNING
ILM работает.
STOPPING
ILM завершает чувствительные действия, такие как сжатие, которые находятся в процессе. После завершения этих действий ILM перейдет в состояние STOPPED.
STOPPED
ILM не работает.

Примеры

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

resp = client.ilm.get_status()
print(resp)
response = client.ilm.get_status
puts response
const response = await client.ilm.getStatus();
console.log(response);
GET _ilm/status

При успешном запросе в теле ответа отображается режим работы:

{
  "operation_mode": "RUNNING"
}

© 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-get-status.html

Spec-Zone.ru

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