调用ListInstanceIndices,获取集群的索引列表。

调试

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

请求头

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

请求语法

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

请求参数

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

实例ID。

all Boolean Query false

是否获取所有索引,取值含义如下:

  • true:返回包含系统索引在内的索引列表。
  • false(默认值):返回除系统索引外的索引列表。
name String Query log-0001

索引名称。

isManaged Boolean Query false

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

  • true:只查看托管中的索引。
  • false(默认值):查看全部索引。
isOpenstore Boolean Query false

是否仅查看OpenStore冷阶段索引。可选值:

  • true:仅查看OpenStore冷阶段索引。
  • flase(默认值):查看全部索引。
page Integer Query 1

实例列表的页码。起始值:1,默认值:1。

size Integer Query 15

分页查询时设置的每页条数。最大值:100,默认值:20。

返回数据

名称 类型 示例值 描述
Headers Struct

返回头信息。

X-Managed-Count Integer 15

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

X-Managed-StorageSize Long 18093942932

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

X-OSS-Count Integer 5

OpenStore冷阶段索引总条数。

X-OSS-StorageSize Long 9093942932

该实例的OpenStore冷阶段索引总大小。单位:B。

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

请求ID。

Result Array of Result

索引列表详情。

createTime String 2021-01-11T05:49:41.114Z

查询索引列表的时间。

health String green

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

  • green:健康。
  • yellow:报警。
  • red:异常。
ilmExplain String { "indices": { ".ds-console-2021.08.18-000002": { "index": ".ds-console-2021.08.18-000002", "managed": true, "policy": "console", "lifecycle_date_millis": 1629277498775, "age": "2.64h", "phase": "hot", "phase_time_millis": 1629277450334, "action": "complete", "action_time_millis": 1629278605586, "step": "complete", "step_time_millis": 1629278605586, "phase_execution": { "policy": "console", "phase_definition": { "min_age": "0s", "actions": { "rollover": { "max_size": "1gb", "max_age": "1d", "max_docs": 10000 }, "set_priority": { "priority": 1000 } } }, "version": 1, "modified_date_in_millis": 1629277370953 } } } }

当前索引的全量生命周期状态。

isManaged String false

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

managedStatus String closing

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

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

索引名称。

phase String warm

当前存储生命周期。取值含义:

  • warm:温阶段。
  • cold:冷阶段。
  • hot:热阶段。
  • delete:删除阶段。
说明 为空时,表示当前索引不被生命周期所管理。
size Long 49298589

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

示例

请求示例

GET /openapi/instances/es-cn-tl329rbpc0001****/indices HTTP/1.1

正常返回示例

JSON格式

{
    "RequestId": "F99407AB-2FA9-489E-A259-40CF6DCC****",
    "Result": [
        {
            "name": ".kibana_task_manager_1",
            "health": "green",
            "size": 4929858933232,
            "createTime": "2021-01-11T05:49:41.114Z",
            "managedStatus": "closing",
            "phase": null,
            "ilmExplain": "{\n    \"indices\": {\n        \".kibana_task_manager_1\": {\n            \"index\": \".kibana_task_manager_1\",\n            \"managed\": false\n        }\n    }\n}"
        },
        {
            "name": ".ds-console-2021.08.18-000002",
            "health": "yellow",
            "size": 49298589,
            "createTime": "2021-01-11T05:49:41.114Z",
            "managedStatus": "following",
            "phase": "warm",
            "ilmExplain": "{\n  \"indices\": {\n    \".ds-console-2021.08.18-000002\": {\n      \"index\": \".ds-console-2021.08.18-000002\",\n      \"managed\": true,\n      \"policy\": \"console\",\n      \"lifecycle_date_millis\": 1629277498775,\n      \"age\": \"2.64h\",\n      \"phase\": \"hot\",\n      \"phase_time_millis\": 1629277450334,\n      \"action\": \"complete\",\n      \"action_time_millis\": 1629278605586,\n      \"step\": \"complete\",\n      \"step_time_millis\": 1629278605586,\n      \"phase_execution\": {\n        \"policy\": \"console\",\n        \"phase_definition\": {\n          \"min_age\": \"0s\",\n          \"actions\": {\n            \"rollover\": {\n              \"max_size\": \"1gb\",\n              \"max_age\": \"1d\",\n              \"max_docs\": 10000\n            },\n            \"set_priority\": {\n              \"priority\": 1000\n            }\n          }\n        },\n        \"version\": 1,\n        \"modified_date_in_millis\": 1629277370953\n      }\n    }\n  }\n}"
        }
    ],
    "Headers": {
        "X-Managed-Count": 15,
        "X-Managed-StorageSize": 18093942932,
        "X-OSS-Count": 5,
        "X-OSS-StorageSize": 9093942932
    }
}

错误码

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