调用ListInstanceIndices,获取集群的索引列表。仅展示独立索引。

调试

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

请求头

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

请求语法

GET /openapi/instances/[InstanceId]/indices HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
InstanceId String Path es-cn-n6w24n9u900am****

实例ID。

lang String Query en

配置语言,支持多种语言。

name String Query log-0001

索引名称。

isManaged Boolean Query true

是否只显示托管中的索引,取值含义如下:

  • true:只显示托管中的索引。
  • false(默认值):显示全部索引。

返回数据

名称 类型 示例值 描述
Headers Struct

返回头信息。

X-Managed-Count Integer 15

云端托管中的索引总个数。

X-Managed-StorageSize Long 18093942932

云端托管中的索引总大小。单位:Byte。

RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

请求ID。

Result Array of Result

索引列表详情。

createTime String String

查询索引列表的时间。

health String Green

索引的运行状态,支持以下三种状态:

  • Green:健康。
  • Yellow:报警。
  • Red:异常。
isManaged String true

该参数已废弃,无需关注。

managedStatus String following

索引托管状态,支持以下三种状态:

  • following:托管中。
  • closing:取消托管中。
  • closed:未托管。
name String test1

索引名称。

size Long 4929858933232

当前索引所占用的总存储空间。单位:Byte。

示例

请求示例

GET /openapi/instances/es-cn-n6w24n9u900am****/indices?name=log1&isManaged=true HTTP/1.1

正常返回示例

JSON格式

{
    "RequestId": "F99407AB-2FA9-489E-A259-40CF6DCC****",
    "Result": [
        {
            "name": "test1",
            "health": "green",
            "size": 4929858933232,
            "createTime": "2021-01-11T05:49:41.114Z",
            "managedStatus": "following"
        },
        {
            "name": "test2",
            "health": "yellow",
            "size": 49298589,
            "createTime": "2021-01-11T05:49:41.114Z",
            "managedStatus": "closing"
        }
    ],
    "Headers": {
        "X-Managed-Count": 15,
        "X-Managed-StorageSize": 18093942932
    }
}

错误码

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