接口请求域名： es.intl.tencentcloudapi.com 。
获取索引列表
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeIndexList。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| IndexType | 是 | String | 索引类型。auto：自治索引；normal：普通索引 |
| InstanceId | 否 | String | ES集群ID |
| IndexName | 否 | String | 索引名，若填空则获取所有索引 |
| Username | 否 | String | 集群访问用户名 |
| Password | 否 | String | 集群访问密码 |
| Offset | 否 | Integer | 分页起始位置 |
| Limit | 否 | Integer | 一页展示数量 |
| OrderBy | 否 | String | 排序字段，支持索引名：IndexName、索引存储量：IndexStorage、索引创建时间：IndexCreateTime |
| IndexStatusList.N | 否 | Array of String | 过滤索引状态 |
| Order | 否 | String | 排序顺序，支持asc、desc，默认为desc 数据格式"asc","desc" |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| IndexMetaFields | Array of IndexMetaField | 索引元数据字段 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 查询总数 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
获取索引元数据
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIndexList
<公共请求参数>
{
"Username": "elastic",
"IndexName": "index_test",
"IndexType": "auto",
"InstanceId": "es-abcdefgh",
"Limit": 0,
"Offset": 10,
"Password": "ascq23***********cjaw"
}
{
"Response": {
"IndexMetaFields": [
{
"IndexType": "auto",
"IndexName": "index_test",
"IndexMetaJson": "{\"f1\":52}",
"IndexStatus": "green",
"IndexStorage": 0,
"IndexCreateTime": "2024-12-05 17:22:44",
"BackingIndices": [
{
"IndexName": "index_test0",
"IndexStatus": "green",
"IndexStorage": 0,
"IndexPhrase": "data_hot",
"IndexCreateTime": "2024-12-05 17:22:44"
}
],
"ClusterId": "es-hhio223",
"ClusterName": "test-cluster",
"ClusterVersion": "7.14.0",
"IndexPolicyField": {
"WarmEnable": "true",
"WarmMinAge": "16",
"ColdEnable": "true",
"ColdMinAge": "8",
"FrozenEnable": "false",
"FrozenMinAge": "0",
"ColdAction": "migrate"
},
"IndexOptionsField": {
"ExpireMaxAge": "1d",
"ExpireMaxSize": "1024",
"RolloverMaxAge": "1d",
"RolloverDynamic": "true",
"ShardNumDynamic": "true",
"TimestampField": "TIMESTAMP",
"WriteMode": "append_only"
},
"IndexSettingsField": {
"NumberOfShards": "2",
"NumberOfReplicas": "1",
"RefreshInterval": "30s"
},
"AppId": 1,
"IndexDocs": 1
}
],
"TotalCount": 0,
"RequestId": "ah782-j*************c-ih89"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.RequestTimeOut | 请求超时。 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
| InvalidParameter.InvalidIndexType | 索引类型IndexType的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId，没有找到对应资源。 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
文档反馈