Elasticsearch Service
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > Elasticsearch Service > API 文档 > 实例相关接口 > 获取索引列表

获取索引列表

最近更新时间：2024-03-12 01:30:25

我的收藏

本页目录：

1. 接口描述

接口请求域名： es.tencentcloudapi.com 。

获取索引列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeIndexList。
Version 是 String 公共参数，本接口取值：2018-04-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
IndexType 是 String 索引类型。auto：自治索引；normal：普通索引
示例值：auto
InstanceId 否 String ES集群ID
示例值：es-abcdefgh
IndexName 否 String 索引名，若填空则获取所有索引
示例值：test
Username 否 String 集群访问用户名
示例值：elastic
Password 否 String 集群访问密码
示例值：123456
Offset 否 Integer 分页起始位置
示例值：0
Limit 否 Integer 一页展示数量
示例值：20
OrderBy 否 String 排序字段，支持索引名：IndexName、索引存储量：IndexStorage、索引创建时间：IndexCreateTime
示例值：storage
IndexStatusList.N 否 Array of String 过滤索引状态
示例值：["GREEN"]
Order 否 String 排序顺序，支持asc、desc，默认为desc 数据格式"asc","desc"
示例值：asc

3. 输出参数

参数名称 类型 描述
IndexMetaFields Array of IndexMetaField 索引元数据字段
注意：此字段可能返回 null，表示取不到有效值。
TotalCount Integer 查询总数
注意：此字段可能返回 null，表示取不到有效值。
示例值：10
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取索引元数据

获取索引元数据

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIndexList
<公共请求参数>

{
    "Username": "elastic",
    "IndexName": "test",
    "IndexType": "auto",
    "InstanceId": "es-abcdefgh",
    "Limit": 0,
    "Offset": 10,
    "Password": "123456"
}

输出示例

{
    "Response": {
        "IndexMetaFields": [
            {
                "IndexType": "abc",
                "IndexName": "abc",
                "IndexMetaJson": "abc",
                "IndexStatus": "abc",
                "IndexStorage": 0,
                "IndexCreateTime": "abc",
                "BackingIndices": [
                    {
                        "IndexName": "abc",
                        "IndexStatus": "abc",
                        "IndexStorage": 0,
                        "IndexPhrase": "abc",
                        "IndexCreateTime": "abc"
                    }
                ],
                "ClusterId": "abc",
                "ClusterName": "abc",
                "ClusterVersion": "abc",
                "IndexPolicyField": {
                    "WarmEnable": "abc",
                    "WarmMinAge": "abc",
                    "ColdEnable": "abc",
                    "ColdMinAge": "abc",
                    "FrozenEnable": "abc",
                    "FrozenMinAge": "abc",
                    "ColdAction": "abc"
                },
                "IndexOptionsField": {
                    "ExpireMaxAge": "abc",
                    "ExpireMaxSize": "abc",
                    "RolloverMaxAge": "abc",
                    "RolloverDynamic": "abc",
                    "ShardNumDynamic": "abc",
                    "TimestampField": "abc",
                    "WriteMode": "abc"
                },
                "IndexSettingsField": {
                    "NumberOfShards": "abc",
                    "NumberOfReplicas": "abc",
                    "RefreshInterval": "abc"
                },
                "AppId": 1,
                "IndexDocs": 1
            }
        ],
        "TotalCount": 0,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.RequestTimeOut 请求超时。
InternalError 内部错误。
InvalidParameter.InvalidAppId AppId的取值和预期不符。
InvalidParameter.InvalidEsVersion 实例版本EsVersion的取值和预期不符。
InvalidParameter.InvalidIndexType 索引类型IndexType的取值和预期不符。
InvalidParameter.InvalidInstanceId 无效的InstanceId，没有找到对应资源。
ResourceNotFound.ClusterInfoNotFound 集群资源获取失败。
ResourceNotFound.DBInfoNotFound 数据库资源获取失败。
中国站