DescribeTemplates - 获取实例的场景模板配置

更新时间:
复制 MD 格式

获取实例的场景模板配置,集群settings配置。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:DescribeTemplates

get

*Instance

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

无 无

请求语法

GET /openapi/instances/{InstanceId}/templates HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID。

es-cn-n6w1o1x0w001c****

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

Result

array<object>

返回结果。

object

content

string

模板内容。

{\n\t\"persistent\":{\n\t\t\"search\":{\n\t\t\t\"max_buckets\":\"10000\"\n\t\t}\n\t}\n}

templateName

string

模板名称。支持:

  • staticSettings:elasticsearch.yml 配置

  • ilmPolicy:索引生命周期配置

  • indexTemplate:索引模板配置

  • dynamicSettings:集群动态配置

dynamicSettings

示例

正常返回示例

JSON格式

{
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****",
  "Result": [
    {
      "content": "{\\n\\t\\\"persistent\\\":{\\n\\t\\t\\\"search\\\":{\\n\\t\\t\\t\\\"max_buckets\\\":\\\"10000\\\"\\n\\t\\t}\\n\\t}\\n}",
      "templateName": "dynamicSettings"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 InstanceNotFound The instanceId provided does not exist

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

变更历史

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