クラスターを照会します。
操作説明
メソッド
GET
URI
/openapi/ha3/instances/{instanceId}/clusters
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
searchengine:ListClusters |
list |
*Instance
|
なし | なし |
リクエスト構文
GET /openapi/ha3/instances/{instanceId}/clusters HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンス ID。 |
ha-cn-pl32rf0**** |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
リクエストパラメーターは必要ありません。
リクエスト例
GET /openapi/ha3/instances/ha3_instance_name/clusters
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| requestId |
string |
リクエスト ID。 |
F43E8AB4-419C-5F4C-90D6-615590DFAA3C |
| result |
array<object> |
クラスター。 |
|
|
array<object> |
クラスターのリスト。 |
||
| name |
string |
クラスター名。 |
hz_pre_vpc_domain_1 |
| description |
string |
クラスターの説明。 |
自定义描述 |
| currentAdvanceConfigVersion |
string |
有効な詳細設定バージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| latestAdvanceConfigVersion |
string |
最新の詳細設定バージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| currentOnlineConfigVersion |
string |
有効なオンライン設定バージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| latestOnlineConfigVersion |
string |
最新のオンライン設定バージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| currentOnlineQueryConfigVersion |
string |
有効なクエリ設定バージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| latestOnlineQueryConfigVersion |
string |
最新のクエリ設定バージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| currentOfflineDictConfigVersion |
string |
有効な辞書設定バージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| latestOfflineDictConfigVersion |
string |
最新の辞書設定バージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| configUpdateTime |
string |
設定が更新された時刻。 |
2024-05-21 16:05:26 |
| status |
string |
クラスターのステータス。 有効な値： running：実行中、starting：起動中、stopping：停止中、stopped：停止済み。 |
running |
| queryNode |
object |
Query Result Searcher (QRS) ワーカーに関する情報。 |
|
| name |
string |
QRS ワーカーの名前。 |
ha-cn-pl32rf0****_qrs |
| number |
integer |
QRS ワーカーの数。 |
1 |
| partition |
integer |
QRS ワーカーに格納されているパーティションの ID。 |
1 |
| dataNode |
object |
Searcher ワーカーに関する情報。 |
|
| name |
string |
Searcher ワーカーの名前。 |
general |
| number |
integer |
Searcher ワーカーの数。 |
1 |
| partition |
integer |
Searcher ワーカーに格納されているパーティションの ID。 |
1 |
| createTime |
string |
クラスターが作成された時刻。 |
2024-05-21 16:05:26 |
| config |
object |
設定情報。 |
|
|
object |
設定情報。 |
||
|
object |
子設定項目に関する情報。 |
||
| name |
string |
設定名。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| updateTime |
string |
設定が更新された時刻。 |
2024-05-21 16:05:26 |
| desc |
string |
設定の説明。 |
自定义描述 |
レスポンス例
正常なレスポンス
{
"requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
"result": [
{
"name": "cluster1",
"configUpdateTime": "2021-08-09 00:01:02",
"currentAdvanceConfigVersion": "test_yyds_data1",
"lastestAdvanceConfigVersion": "test_yyds_data1",
"currentOnlineConfigVersion": "test_yyds_data1",
"lastestOnlineConfigVersion": "test_yyds_data1",
"description": "airecpre",
"queryNode": {
"number": 1
},
"dataNode": {
"number": 2,
"partition": 1
},
},
{
"name": "cluster2",
"configUpdateTime": "2021-08-09 00:01:02",
"currentAdvanceConfigVersion": "test_yyds_data2",
"lastestAdvanceConfigVersion": "test_yyds_data2",
"currentOnlineConfigVersion": "test_yyds_data1",
"lastestOnlineConfigVersion": "test_yyds_data1",
"description": "this is descrition",
"queryNode": {
"number": 1
},
"dataNode": {
"number": 2,
"partition": 1
}
}
]
}
例
成功レスポンス
JSONJSON
{
"requestId": "F43E8AB4-419C-5F4C-90D6-615590DFAA3C",
"result": [
{
"name": "hz_pre_vpc_domain_1",
"description": "自定义描述",
"currentAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"latestAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"currentOnlineConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"latestOnlineConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"currentOnlineQueryConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"latestOnlineQueryConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"currentOfflineDictConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"latestOfflineDictConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"configUpdateTime": "2024-05-21 16:05:26",
"status": "running",
"queryNode": {
"name": "ha-cn-pl32rf0****_qrs",
"number": 1,
"partition": 1
},
"dataNode": {
"name": "general",
"number": 1,
"partition": 1
},
"createTime": "2024-05-21 16:05:26",
"config": {
"key": {
"key": {
"name": "ha-cn-pl32rf0****_offline_adv_v1",
"updateTime": "2024-05-21 16:05:26",
"desc": "自定义描述"
}
}
}
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。