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

编辑

检索当前的索引生命周期管理(ILM) 状态。

您可以使用启动 ILM停止 ILM API 来启动或停止 ILM。

请求

编辑

GET /_ilm/status

前提条件

编辑
  • 如果启用了 Elasticsearch 安全功能,则必须拥有manage_ilmread_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"
}