› › ›

API получения политики жизненного цикла

Запрос

GET _ilm/policy

GET _ilm/policy/<policy_id>

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

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

Описание

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

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

<policy_id>: (Необязательно, строка) Идентификатор политики.

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

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

Примеры

Следующий пример получает my_policy:

resp = client.ilm.get_lifecycle(
    name="my_policy",
)
print(resp)

response = client.ilm.get_lifecycle(
  policy: 'my_policy'
)
puts response

const response = await client.ilm.getLifecycle({
  name: "my_policy",
});
console.log(response);

GET _ilm/policy/my_policy

Если запрос выполнен успешно, тело ответа содержит определение политики:

{
  "my_policy": {
    "version": 1, 
    "modified_date": 82392349, 
    "policy": {
      "phases": {
        "warm": {
          "min_age": "10d",
          "actions": {
            "forcemerge": {
              "max_num_segments": 1
            }
          }
        },
        "delete": {
          "min_age": "30d",
          "actions": {
            "delete": {
              "delete_searchable_snapshot": true
            }
          }
        }
      }
    },
    "in_use_by" : { 
      "indices" : [],
      "data_streams" : [],
      "composable_templates" : []
    }
  }
}

	Версия политики увеличивается всякий раз, когда политика обновляется
	Когда эта политика была в последний раз изменена
	Какие индексы, потоки данных или шаблоны в настоящее время используют эту политику

© 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-lifecycle.html