Elasticsearch 简明教程

Elasticsearch - Managing Index Lifecycle

管理索引生命周期涉及基于碎片大小和性能要求等因素执行管理操作。指数生命周期管理 (ILM) API 让你可以自动化管理你的索引的方式。

本章列出了 ILM API 及其用法。

Policy Management APIs

API Name

Purpose

Example

Create lifecycle policy.

创建生命周期策略。如果指定策略存在,则将替换该策略并对策略版本进行增量。

PUT_ilm/policy/policy_id

Get lifecycle policy.

返回指定的策略定义。包括策略版本和上次修改日期。如果没有指定策略,则返回所有已定义的策略。

GET_ilm/policy/policy_id

Delete lifecycle policy

删除指定的生命周期策略定义。你无法删除当前正在使用的策略。如果正在使用该策略管理任何索引,则请求将失败并返回错误。

DELETE_ilm/policy/policy_id

Index Management APIs

API Name

Purpose

Example

移至生命周期步骤 API。

手动将索引移至指定步骤并执行该步骤。

POST_ilm/move/index

Retry policy.

将策略设置回出现错误的步骤并执行该步骤。

POST index/_ilm/retry

从索引 API 编辑中删除策略。

删除已分配生命周期策略并停止管理指定的索引。如果指定了索引模式,则将从所有匹配索引中删除已分配的策略。

POST index/_ilm/remove

Operation Management APIs

API Name

Purpose

Example

获取索引生命周期管理状态 API。

返回 ILM 插件的状态。响应中的 operation_mode 域显示三个状态之一:STARTED、STOPPING 或 STOPPED。

GET /_ilm/status

启动索引生命周期管理 API。

如果 ILM 插件当前已停止,则启动它。在形成群集时会自动启动 ILM。

POST /_ilm/start

停止索引生命周期管理 API。

停止所有生命周期管理操作并停止 ILM 插件。在对群集执行维护并需要防止 ILM 对索引执行任何操作时,这非常有用。

POST /_ilm/stop

Explain lifecycle API.

检索有关索引当前生命周期状态的信息,例如当前执行的阶段、操作和步骤。显示索引输入每一个阶段的时间、正在运行阶段的定义以及有关任何故障的信息。

GET index/_ilm/explain