ListComponentIndices - 组合索引列表-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

获取Elasticsearch的组合模板列表。

接口说明

详细信息请参见通过 OpenStore 实现海量数据存储。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:ListComponentIndices

get

*Instance

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	es-cn-tl329rbpc0001****

请求参数

名称	类型	必填	描述	示例值
name	string	否	组合模板名称。	template
page	integer	否	分页查询时设置的页数。默认值：1。	5
size	integer	否	分页查询时设置的每页条数。默认值：10。	10

返回参数

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

示例

正常返回示例

JSON格式

{
  "RequestId": "F99407AB-2FA9-489E-A259-40CF6DCC47D9",
  "Headers": {
    "X-Total-Count": 10
  },
  "Result": [
    {
      "composed": [
        "[\"template1\", \"template2\"]"
      ],
      "name": "synthetics-settings",
      "content": {
        "template": {
          "settings": {
            "index": {
              "lifecycle": {
                "name": "synthetics"
              },
              "codec": "best_compression"
            }
          }
        },
        "_meta": {
          "description": "set number of shards to one"
        },
        "version": 0
      }
    }
  ]
}

错误码

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

变更历史

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