UpdateILMPolicy_Elasticsearch_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
elasticsearch:UpdateILMPolicy
None
Instance
acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}

请求语法

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

路径参数

字段名称字段详情
InstanceIdstring

实例 ID。

示例值:es-cn-nif24adwc0082w2ka****参考取值来源:
    ListInstance
PolicyNamestring

索引生命周期策略名称。

示例值:my-policy

请求参数

字段名称字段详情
ClientTokenstring

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。

示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodystring

请求说明

RequestBody

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

phases 字段数据结构说明

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

actions 字段数据结构说明

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

rollver 字段数据结构说明

参数类型示例值是否必选描述
maxAgeString30d触发滚动索引所需要的时间阈值。maxAge、maxDocs 和 maxSize 三者中至少选填一个。单位:d(天)或者 h(小时)。
maxDocsInteger10000触发滚动索引所需要的文档数量的阈值。
maxSizeString50gb触发滚动索引所需要的索引大小的阈值。maxAge、maxDocs 和 maxSize 三者中至少选填一个。单位:MB 或者 GB。

setPriority 字段数据结构说明

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

allocate 字段数据结构说明

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

require 字段数据结构说明

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

返回参数

字段名称字段详情
Resultstring

返回结果。

示例值:my-policy
RequestIdstring

请求 ID。

示例值:F99407AB-2FA9-489E-A259-40CF6DCC****

返回示例

变更历史

暂无变更历史

相关示例