UpdateIndexTemplate - 修改实例模版配置

更新时间:
复制 MD 格式

修改Elasticsearch实例模版配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdateIndexTemplate

none

*Instance

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

无 无

请求语法

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 中还需要填入以下参数,用来指定待更新的索引模版信息。

参数类型是否必选示例值描述
indexTemplateString是my-template索引模版名称。必须和 path 值相同。
indexPatternsString是["schema1*","schema2*"]索引匹配模式正则。
dataStreamBoolean是true是否开启数据流:true(开启)、false(不开启)。默认值:false(不开启)。
priorityIntegre否30集群索引模板的优先级。
ilmPolicyString否policy-1生命周期策略名称。
templateObject否组件模版。

template 字段数据结构说明

参数类型是否必选示例值描述
settingsString否{"index.refresh_interval":"1s"}settings 设置。
mappingsString否{"properties": {"created_at": {"type": "date","format": "EEE MMM dd HH:mm:ss Z yyyy"},"host_name": {"type": "keyword"}}}mappings 设置。
aliasesString否{"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****"
}

错误码

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

变更历史

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