擷取某一叢集的詳細資料。
介面說明
方法
GET
URI
/openapi/ha3/instance/{instanceId}/clusters/{clusterName}
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
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 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
當前API無需請求參數
請求樣本
GET /openapi/ha3/instance/ha_name_example/clusters/my_cluster
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| 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(建立中) or PUBLISH(建立完成) |
NEW |
| queryNode |
object |
查詢節點規格 |
|
| name |
string |
節點名稱 |
ha-cn-pl32rf0****_qrs |
| number |
integer |
節點數量。 |
1 |
| partition |
integer |
副本數量 |
2 |
| dataNode |
object |
資料節點規格 |
|
| name |
string |
節點名稱 |
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
}
}
}
樣本
正常返回樣本
JSON格式
{
"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": "自訂描述"
}
}
}
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。