› › ›

API объяснения жизненного цикла

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

Запрос

GET <target>/_ilm/explain

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

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

Описание

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

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

<target>: (Обязательно, строка) Список данных потоков, индексов и алиасов, на которые следует ориентироваться, разделенных запятыми. Поддерживаются подстановочные знаки (*). Для указания всех потоков данных и индексов используйте * или _all.

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

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

Примеры

Следующий пример получает состояние жизненного цикла индекса my-index-000001:

GET my-index-000001/_ilm/explain

Когда управление индексом впервые переходит к ILM, explain показывает, что индекс управляется и находится в фазе new:

{
  "indices": {
    "my-index-000001": {
      "index": "my-index-000001",
      "managed": true, 
      "policy": "my_policy", 
      "lifecycle_date_millis": 1538475653281, 
      "age": "15s", 
      "phase": "new",
      "phase_time_millis": 1538475653317, 
      "action": "complete",
      "action_time_millis": 1538475653317, 
      "step": "complete",
      "step_time_millis": 1538475653317 
    }
  }
}

	Показывается, управляется ли индекс ILM. Если индекс не управляется ILM, другие поля не будут показаны
	Название политики, которую ILM использует для этого индекса
	Отметка времени, используемая для `min_age`
	Возраст индекса (используется для расчета времени перехода в следующую фазу)
	Время, когда индекс вошел в текущую фазу
	Время, когда индекс вошел в текущее действие
	Время, когда индекс вошел в текущий шаг

После запуска политики на индексе ответ включает объект phase_execution, который показывает определение текущей фазы. Изменения в основной политике не повлияют на этот индекс до завершения текущей фазы.

{
  "indices": {
    "test-000069": {
      "index": "test-000069",
      "managed": true,
      "policy": "my_lifecycle3",
      "lifecycle_date_millis": 1538475653281,
      "lifecycle_date": "2018-10-15T13:45:21.981Z",
      "age": "25.14s",
      "phase": "hot",
      "phase_time_millis": 1538475653317,
      "phase_time": "2018-10-15T13:45:22.577Z",
      "action": "rollover",
      "action_time_millis": 1538475653317,
      "action_time": "2018-10-15T13:45:22.577Z",
      "step": "attempt-rollover",
      "step_time_millis": 1538475653317,
      "step_time": "2018-10-15T13:45:22.577Z",
      "phase_execution": {
        "policy": "my_lifecycle3",
        "phase_definition": { 
          "min_age": "0ms",
          "actions": {
            "rollover": {
              "max_age": "30s"
            }
          }
        },
        "version": 3, 
        "modified_date": "2018-10-15T13:21:41.576Z", 
        "modified_date_in_millis": 1539609701576 
      }
    }
  }
}

	Определение JSON фазы, загруженное из указанной политики, когда индекс вошёл в эту фазу
	Версия загруженной политики
	Дата последнего изменения загруженной политики
	Эпоха времени последнего изменения загруженной политики

Если ILM ожидает завершения шага, ответ включает информацию о статусе выполняемого на индексе шага.

{
  "indices": {
    "test-000020": {
      "index": "test-000020",
      "managed": true,
      "policy": "my_lifecycle3",
      "lifecycle_date_millis": 1538475653281,
      "lifecycle_date": "2018-10-15T13:45:21.981Z",
      "age": "4.12m",
      "phase": "warm",
      "phase_time_millis": 1538475653317,
      "phase_time": "2018-10-15T13:45:22.577Z",
      "action": "allocate",
      "action_time_millis": 1538475653317,
      "action_time": "2018-10-15T13:45:22.577Z",
      "step": "check-allocation",
      "step_time_millis": 1538475653317,
      "step_time": "2018-10-15T13:45:22.577Z",
      "step_info": { 
        "message": "Waiting for all shard copies to be active",
        "shards_left_to_allocate": -1,
        "all_shards_active": false,
        "number_of_replicas": 2
      },
      "phase_execution": {
        "policy": "my_lifecycle3",
        "phase_definition": {
          "min_age": "0ms",
          "actions": {
            "allocate": {
              "number_of_replicas": 2,
              "include": {
                "box_type": "warm"
              },
              "exclude": {},
              "require": {}
            },
            "forcemerge": {
              "max_num_segments": 1
            }
          }
        },
        "version": 2,
        "modified_date": "2018-10-15T13:20:02.489Z",
        "modified_date_in_millis": 1539609602489
      }
    }
  }
}

Статус выполняемого шага.

Если индекс находится на шаге ERROR, во время выполнения шага в политике произошла ошибка, и вам необходимо принять меры, чтобы индекс перешел к следующему шагу. Некоторые шаги можно безопасно автоматически повторить в определенных обстоятельствах. Чтобы помочь вам диагностировать проблему, ответ explain показывает ошибочный шаг, информацию о шаге, которая предоставляет информацию об ошибке, и информацию о попытках повторного выполнения ошибочного шага, если это необходимо.

{
  "indices": {
    "test-000056": {
      "index": "test-000056",
      "managed": true,
      "policy": "my_lifecycle3",
      "lifecycle_date_millis": 1538475653281,
      "lifecycle_date": "2018-10-15T13:45:21.981Z",
      "age": "50.1d",
      "phase": "hot",
      "phase_time_millis": 1538475653317,
      "phase_time": "2018-10-15T13:45:22.577Z",
      "action": "rollover",
      "action_time_millis": 1538475653317,
      "action_time": "2018-10-15T13:45:22.577Z",
      "step": "ERROR",
      "step_time_millis": 1538475653317,
      "step_time": "2018-10-15T13:45:22.577Z",
      "failed_step": "check-rollover-ready", 
      "is_auto_retryable_error": true, 
      "failed_step_retry_count": 1, 
      "step_info": { 
        "type": "cluster_block_exception",
        "reason": "index [test-000057/H7lF9n36Rzqa-KfKcnGQMg] blocked by: [FORBIDDEN/5/index read-only (api)",
        "index_uuid": "H7lF9n36Rzqa-KfKcnGQMg",
        "index": "test-000057"
      },
      "phase_execution": {
        "policy": "my_lifecycle3",
        "phase_definition": {
          "min_age": "0ms",
          "actions": {
            "rollover": {
              "max_age": "30s"
            }
          }
        },
        "version": 3,
        "modified_date": "2018-10-15T13:21:41.576Z",
        "modified_date_in_millis": 1539609701576
      }
    }
  }
}

	Шаг, вызвавший ошибку
	Указывает, можно ли исправить ошибку, повторив ошибочный шаг. Если это так, ILM автоматически повторит ошибочный шаг.
	Количество попыток автоматического повторения ошибочного шага.
	Описание ошибки

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