クラスターの詳細を照会します。
操作説明
メソッド
GET
URI
/openapi/ha3/instance/{instanceId}/clusters/{clusterName}
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
searchengine:GetCluster |
get |
*Instance
|
なし | なし |
リクエスト構文
GET /openapi/ha3/instances/{instanceId}/clusters/{clusterName} HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンス ID。 |
ha-cn-pl32rf0**** |
| clusterName |
string |
任意 |
クラスターの名前。 |
bj_vpc_domain_2 |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
リクエストパラメーターは必要ありません。
リクエスト例
GET /openapi/ha3/instance/ha_name_example/clusters/my_cluster
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| requestId |
string |
リクエストの ID。 |
E7B7D598-B080-5C8E-AA35-D43EC0D5F886 |
| result |
object |
クラスター。 |
|
| name |
string |
クラスター名。 |
bj_vpc_domain_2 |
| description |
string |
クラスターの説明。 |
自定义描述 |
| currentAdvanceConfigVersion |
string |
有効な詳細設定のバージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| latestAdvanceConfigVersion |
string |
最新の詳細設定のバージョン。 |
ha-cn-pl32rf0****_offline_adv_v1 |
| currentOnlineConfigVersion |
string |
有効なオンライン設定のバージョン。 |
ha-cn-pl32rf0****_online_adv_v1 |
| latestOnlineConfigVersion |
string |
最新のオンライン設定のバージョン。 |
ha-cn-pl32rf0****_online_adv_v1 |
| configUpdateTime |
string |
クラスターが更新された時間。 |
2021-08-09 00:01:02 |
| status |
string |
クラスターの作成ステータス。有効な値：`NEW` と `PUBLISH`。`NEW` はクラスターが作成中であることを示します。`PUBLISH` はクラスターが作成されたことを示します。 |
NEW |
| queryNode |
object |
Query Result Searcher (QRS) ワーカーの仕様。 |
|
| name |
string |
QRS ワーカーの名前。 |
ha-cn-pl32rf0****_qrs |
| number |
integer |
ノード数。 |
1 |
| partition |
integer |
レプリカ数。 |
2 |
| dataNode |
object |
Searcher ワーカーの仕様。 |
|
| name |
string |
Searcher ワーカーの名前。 |
general |
| number |
integer |
レプリカ数です。 |
1 |
| partition |
integer |
パーティション数。 |
2 |
| 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": {
"name":"ha-cn-0ju2iimcu07_qrs",
"number": 1
},
"dataNode": {
"name":"general",
"number": 2,
"partition": 1
}
}
}
例
成功レスポンス
JSONJSON
{
"requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
"result": {
"name": "bj_vpc_domain_2",
"description": "自定义描述",
"currentAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"latestAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
"currentOnlineConfigVersion": "ha-cn-pl32rf0****_online_adv_v1",
"latestOnlineConfigVersion": "ha-cn-pl32rf0****_online_adv_v1",
"configUpdateTime": "2021-08-09 00:01:02",
"status": "NEW",
"queryNode": {
"name": "ha-cn-pl32rf0****_qrs",
"number": 1,
"partition": 2
},
"dataNode": {
"name": "general",
"number": 1,
"partition": 2
},
"createTime": "2024-05-21 16:05:26",
"config": {
"key": {
"key": {
"name": "ha-cn-pl32rf0****_offline_adv_v1\n",
"updateTime": "2024-05-21 16:05:26",
"desc": "自定义描述"
}
}
}
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。