调用ListComponentIndices,获取Elasticsearch的组合模板列表_检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

GET /openapi/instances/{InstanceId}/component-index HTTP/1.1

请求参数


名称	类型	位置	是否必选	示例值	描述
InstanceId	String	Path	是	es-cn-tl329rbpc0001****	实例ID。
name	String	Query	否	template	组合模板名称。
page	Integer	Query	否	5	分页查询时设置的页数。默认值：1。
size	Integer	Query	否	10	分页查询时设置的每页条数。默认值：10。

返回数据


名称	类型	示例值	描述
RequestId	String	F99407AB-2FA9-489E-A259-40CF6DCC47D9	请求ID。
Headers	Object		返回头信息。
X-Total-Count	Long	10	返回结果条数。
Result	Array of Result		返回结果详情。
composed	Array of String	["template1", "template2"]	引用该组合模板的索引模板名构成的数组。
content	Object		组合模板内容。
template	Object		组合模版对象。
settings	Object		模板settings配置。
index	Object		索引信息。
codec	String	best_compression	索引压缩方法。支持： LZ4：Elasticsearch的默认压缩算法，解压或压缩效率很快，但压缩率较低一些。 best_compression：使用best_compression算法进行压缩，具有更高的压缩率。
lifecycle	Object		索引生命周期配置。
name	String	synthetics	生命周期策略名称。
version	Long	0	组合模板的版本。
_meta	Map		元数据，用于存储备注等信息。
name	String	synthetics-settings	组合模板名称。

示例

请求示例

GET /openapi/instances/es-cn-tl329rbpc0001****/component-index?name=template&page=5&size=10 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ {
    "composed" : [ "xxx", "xddd" ],
    "name" : "synthetics-settings",
    "content" : {
      "template" : {
        "settings" : {
          "index" : {
            "lifecycle" : {
              "name" : "synthetics"
            },
            "codec" : "best_compression"
          }
        }
      },
      "_meta" : {
        "managed" : true,
        "description" : "default settings for the synthetics index template installed by x-pack"
      },
      "version" : 0
    }
  } ],
  "RequestId" : "4405A990-49AC-46A1-9960-FA4FAEE4A425",
  "Headers" : {
    "X-Total-Count" : 7
  }
}

错误码

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