調用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 |
是否獲取所有索引，取值含義如下：
|
| name | String | Query | 否 | log-0001 |
索引名稱，支持模糊匹配。 |
| isManaged | Boolean | Query | 否 | false |
是否只查看托管中的索引，取值含義如下：
|
| isOpenstore | Boolean | Query | 否 | false |
是否僅查看OpenStore冷階段索引。可選值：
|
| page | Integer | Query | 否 | 1 |
實例列表的頁碼。起始值：1，默認值：1。 |
| size | Integer | Query | 否 | 15 |
分頁查詢時設置的每頁條數。最大值：100，默認值：20。 |
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | F99407AB-2FA9-489E-A259-40CF6DCC**** |
請求ID。 |
| Headers | Object |
返回頭信息。 |
|
| X-Managed-StorageSize | Long | 18093942932 |
云端托管中的索引總大小。單位：Byte。 |
| X-Managed-Count | Integer | 15 |
云端托管中的索引總個數。 |
| X-OSS-StorageSize | Long | 9093942932 |
該實例的OpenStore冷階段索引總大小。單位：Byte。 |
| X-OSS-Count | Integer | 5 |
OpenStore冷階段索引總條數。 |
| Result | Array of Result |
索引列表詳情。 |
|
| isManaged | String | false |
該參數已廢棄，無需關注。 |
| createTime | String | 2021-01-11T05:49:41.114Z |
查詢索引列表的時間。 |
| size | Long | 49298589 |
當前索引所占用的總存儲空間。單位：Byte。 |
| managedStatus | String | closing |
索引托管狀態，支持以下三種狀態：
|
| name | String | .kibana_task_manager_1 |
索引名稱。 |
| health | String | green |
索引的運行狀態，支持以下三種狀態：
|
| phase | String | warm |
當前存儲生命周期。取值含義：
說明 為空時，表示當前索引不被生命周期所管理。
|
| 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 } } } } |
當前索引的全量生命周期狀態。 |
示例
請求示例
GET /openapi/instances/es-cn-tl329rbpc0001****/indices?all=false&name=log-0001&isManaged=false&isOpenstore=false&page=1&size=15 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json正常返回示例
JSON格式
HTTP/1.1 200 OK
Content-Type:application/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",
"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
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。