修改Elasticsearch实例模版配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
elasticsearch:UpdateIndexTemplate |
none |
*Instance
|
无 | 无 |
请求语法
PUT /openapi/instances/{InstanceId}/index-templates/{IndexTemplate} HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
es-cn-n6w24n9u900am**** |
| IndexTemplate |
string |
是 |
索引模版名称。 |
my-template |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClientToken |
string |
否 |
用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。 |
5A2CFF0E-5718-45B5-9D4D-70B3FF**** |
| body |
string |
否 |
待更新的索引模板名称、匹配模式及模板配置。 |
{"indexTemplate":"my-template","indexPatterns":["schema1*","schema2*"],"dataStream":true} |
RequestBody
RequestBody 中还需要填入以下参数,用来指定待更新的索引模版信息。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
| indexTemplate | String | 是 | my-template | 索引模版名称。必须和 path 值相同。 |
| indexPatterns | String | 是 | ["schema1*","schema2*"] | 索引匹配模式正则。 |
| dataStream | Boolean | 是 | true | 是否开启数据流:true(开启)、false(不开启)。默认值:false(不开启)。 |
| priority | Integre | 否 | 30 | 集群索引模板的优先级。 |
| ilmPolicy | String | 否 | policy-1 | 生命周期策略名称。 |
| template | Object | 否 | 组件模版。 |
template 字段数据结构说明
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
| settings | String | 否 | {"index.refresh_interval":"1s"} | settings 设置。 |
| mappings | String | 否 | {"properties": {"created_at": {"type": "date","format": "EEE MMM dd HH:mm:ss Z yyyy"},"host_name": {"type": "keyword"}}} | mappings 设置。 |
| aliases | String | 否 | {"mydata": {}} | aliases 设置。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Result |
string |
更新的索引模板名称。 |
my-template |
| RequestId |
string |
请求 ID。 |
F99407AB-2FA9-489E-A259-40CF6DCC**** |
示例
正常返回示例
JSON格式
{
"Result": "my-template",
"RequestId": "F99407AB-2FA9-489E-A259-40CF6DCC****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。