Elasticsearch クラスタに格納されているインデックスをクエリします。
デバッグ
リクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。 詳細については、「共通リクエストヘッダー」をご参照ください。
リクエスト構文
GET /openapi/instances/{InstanceId}/indices HTTP/1.1リクエストパラメーター
| パラメーター | タイプ | 位置 | 必須 | 例 | 説明 |
| InstanceId | String | Path | はい | es-cn-tl329rbpc0001**** | インスタンス ID。 |
| all | ブール値 | Query | いいえ | false | すべてのインデックスを取得するかどうかを指定します。有効な値：
|
| name | String | Query | いいえ | log-0001 | インデックスの名前。あいまい一致がサポートされています。 |
| isManaged | ブール値 | Query | いいえ | false | ホスト内のインデックスのみを表示するかどうかを指定します。有効な値：
|
| isOpenstore | ブール値 | 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 | Cloud Hosting 内のインデックスの合計サイズ。単位：バイト。 |
| X-Managed-Count | Integer | 15 | Cloud Hosting 内のインデックスの総数。 |
| X-OSS-StorageSize | Long | 9093942932 | このインスタンスの OpenStore コールドステージインデックスの合計サイズ。単位：バイト。 |
| X-OSS-Count | Integer | 5 | OpenStore コールドフェーズにおけるインデックスの総数。 |
| Result | Result の配列 | インデックスリストの詳細。 | |
| isManaged | String | false | このパラメーターは非推奨です。 |
| createTime | String | 2021-01-11T05:49:41.114Z | インデックスリストがクエリされた時刻。 |
| size | Long | 49298589 | 現在のインデックスが占有する合計ストレージ容量。単位：バイト。 |
| managedStatus | String | closing | インデックスの管理ステータス。次の 3 つのステータスがサポートされています。
|
| name | String | .kibana_task_manager_1 | Elasticsearch インデックスの名前。 |
| health | String | green | インデックスの実行ステータス。次の 3 つのステータスがサポートされています。
|
| 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
}
}エラーコード
エラーコードのリストについては、API エラーセンターをご覧ください。