UpdateILMPolicy - 修改索引生命周期策略-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

调试

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdateILMPolicy

none

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}

无

PUT /openapi/instances/{InstanceId}/ilm-policies/{PolicyName} HTTP/1.1

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。	5A2CFF0E-5718-45B5-9D4D-70B3FF****
body	string	否	待更新索引生命周期策略的名称及各阶段配置。

参数	类型	示例值	是否必选	描述
name	String	my-policy	是	索引生命周期策略名称。
phases	Map		否	索引生命周期策略内容。详情请参见phases 字段数据结构说明。

phases 字段数据结构说明

参数	类型	示例值	是否必选	描述
{key}	Struct		否	当前生命周期阶段，支持以下三种阶段：hot（热数据阶段，正在积极更新和查询索引）；cold（冷数据阶段，索引不再被更新并且很少被查询。信息仍然需要可搜索，但是如果这些查询速度较慢也可以。）；delete（删除阶段，不再需要该索引，可以安全地将其删除）。
minAge	String	30d	否	索引到达目标阶段所需要的时间。
actions	Struct		否	当前阶段策略设置。详情请参见actions 字段数据结构说明。

actions 字段数据结构说明

参数	类型	示例值	是否必选	描述
rollver	Struct		否	hot 阶段的索引滚动更新操作。详情请参见rollver 字段数据结构说明。
setPriority	Struct		否	hot 或 cold 阶段的索引优先级。详情请参见setPriority 字段数据结构说明。
allocate	Struct		否	cold 阶段的分配操作。详情请参见allocate 字段数据结构说明。
delete	Struct	{}	否	删除索引操作。delete 阶段开启时，属性必传，为空对象。

rollver 字段数据结构说明

参数	类型	示例值	是否必选	描述
maxAge	String	30d	否	触发滚动索引所需要的时间阈值。maxAge、maxDocs 和 maxSize 三者中至少选填一个。单位：d（天）或者 h（小时）。
maxDocs	Integer	10000	否	触发滚动索引所需要的文档数量的阈值。
maxSize	String	50gb	否	触发滚动索引所需要的索引大小的阈值。maxAge、maxDocs 和 maxSize 三者中至少选填一个。单位：MB 或者 GB。

setPriority 字段数据结构说明

参数	类型	示例值	是否必选	描述
priority	Integer	100	否	当前节点默认的优先级。

allocate 字段数据结构说明

参数	类型	示例值	是否必选	描述
numberOfReplicas	Integer	1	否	分配指定的副本数，如果设置，则默认值为 1。与 migrate 配合使用，开启自动迁移时，默认进行副本数分配。
require	Struct		否	可选设置，冷热分离架构集群可用。详情请参见require 字段数据结构说明。

require 字段数据结构说明

参数	类型	示例值	是否必选	描述
boxType	String	warm	否	自定义节点属性标识，冷热分离架构集群可用，迁移至冷节点。可选值：warm。

正常返回示例

JSON格式

{
  "Result": "my-policy",
  "RequestId": "F99407AB-2FA9-489E-A259-40CF6DCC****"
}

访问错误中心查看更多错误码。

更多信息，参考变更详情。