获取生命周期策略 API

编辑

检索生命周期策略。

请求

编辑

GET _ilm/policy

GET _ilm/policy/<policy_id>

先决条件

编辑
  • 如果启用了 Elasticsearch 安全功能,您必须拥有 manage_ilmread_ilm 或同时拥有这两种集群权限才能使用此 API。有关更多信息,请参阅安全权限

描述

编辑

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

路径参数

编辑
<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" : []
    }
  }
}

每当更新策略时,策略版本都会递增

此策略上次修改的时间

哪些索引、数据流或模板当前正在使用此策略