› › ›

API перемещения в этап жизненного цикла

Вызывает выполнение определенного этапа в политике жизненного цикла.

Запрос

POST _ilm/move/<index>

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

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

Описание

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

Ручное перемещение индекса в указанный этап и выполнение этого этапа. В теле запроса необходимо указать текущий и целевой этапы.

Запрос завершится ошибкой, если текущий этап не соответствует этапу, который в настоящее время выполняется для индекса. Это предотвращает перемещение индекса из неожидаемого этапа в следующий.

При указании целевого (next_step) этапа перемещения индекса, поля name или оба поля action и name являются необязательными. Если указан только этап, индекс переместится на первый шаг первого действия в указанной фазе. Если указаны фаза и действие, индекс переместится на первый шаг указанного действия в указанной фазе. Действительными считаются только действия, указанные в политике ILM, индекс не может переместиться в этап, который не является частью его политики.

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

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

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

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

Тело запроса

current_step

(Обязательно, объект)

Свойства current_step

phase: (Обязательно, строка) Название текущей фазы. Должно соответствовать фазе, возвращаемой API explain.
action: (Обязательно, строка) Название текущего действия. Должно соответствовать действию, возвращаемому API explain.
name: (Обязательно, строка) Название текущего этапа. Должно соответствовать этапу, возвращаемому API explain. Если ILM столкнется с проблемой во время выполнения действия, он остановит выполнение политики и перейдет к этапу ERROR. Если вы пытаетесь продвинуть политику после устранения неполадок, укажите этот этап ERROR как текущий этап. Дополнительную информацию см. в разделе Устранение неполадок в управлении жизненным циклом индексов.

next_step

(Обязательно, объект)

Свойства next_step

phase: (Обязательно, строка) Название фазы, содержащей действие, которое вы хотите выполнить или продолжить.
action: (Обязательно, строка) Название действия, которое вы хотите выполнить или продолжить.
name: (Обязательно, строка) Название этапа, в который необходимо переместиться и выполнить.

Примеры

В следующем примере индекс my-index-000001 перемещается из начального этапа в этап forcemerge:

POST _ilm/move/my-index-000001
{
  "current_step": { 
    "phase": "new",
    "action": "complete",
    "name": "complete"
  },
  "next_step": { 
    "phase": "warm",
    "action": "forcemerge", 
    "name": "forcemerge" 
  }
}

	Этап, в котором индекс должен находиться
	Этап, который вы хотите выполнить
	Необязательное действие, в который индекс будет перемещен
	Необязательное имя этапа, в который индекс будет перемещен

При успешном выполнении запроса вы получите следующий результат:

{
  "acknowledged": true
}

Запрос завершится ошибкой, если индекс не находится в фазе new, как указано в запросе current_step.

© 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-move-to-step.html