擷取叢集資訊。
介面說明
方法
GET
URI
/openapi/ha3/instances/{instanceId}/cluster-run-time-info
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
searchengine:GetClusterRunTimeInfo |
get |
*Instance
|
無 | 無 |
請求文法
GET /openapi/ha3/instances/{instanceId}/cluster-run-time-info HTTP/1.1路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| instanceId |
string |
是 |
執行個體 ID |
ha-cn-pl32rf0**** |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
當前API無需請求參數
請求樣本
GET /openapi/ha3/instances/ose-test1/cluster-run-time-info
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| requestId |
string |
請求 ID。 |
E45380E8-994A-5402-9806-F114B3295FCF |
| result |
array<object> |
返回結果。 |
|
|
array<object> |
叢集運行時間長度資訊。 |
||
| clusterName |
string |
叢集名稱 |
vpc_hz_domain_1 |
| queryNode |
object |
查詢結點資訊 |
|
| serviceStatus |
object |
服務狀態 |
|
| name |
string |
叢集名稱 |
vpc_hz_domain_1 |
| totalSize |
integer |
總大小 |
100 |
| doneSize |
integer |
完成大小 |
100 |
| donePercent |
integer |
進度 |
100 |
| configStatusList |
array<object> |
配置狀態列表。 |
|
|
object |
配置狀態列表。 |
||
| configUpdateTime |
string |
叢集更新時間 |
2024-05-21 16:05:26 |
| name |
string |
叢集名稱 |
vpc_hz_domain_1 |
| totalSize |
integer |
總大小 |
6 |
| doneSize |
integer |
完成大小 |
100 |
| donePercent |
integer |
進度 |
100 |
| dataNodes |
array<object> |
資料結點資訊 |
|
|
array<object> |
叢集節點資訊。 |
||
| dataStatusList |
array<object> |
節點資料列表。 |
|
|
array<object> |
節點資料列表。 |
||
| docSize |
integer |
儲存容量 (單位:GB) |
2 |
| fullVersion |
integer |
全量版本 |
1718846192 |
| incVersion |
integer |
增量版本 |
1718846192 |
| incUpdateTime |
string |
累加式更新時間 |
2024-05-21 16:05:26 |
| fullUpdateTime |
string |
全量更新時間 |
2024-05-21 16:05:26 |
| indexConfigInfo |
object |
索引配置 |
|
| configMetaName |
string |
索引配置名稱 |
index_meta_name |
| version |
integer |
索引模板的版本。 |
1.0.0 |
| advanceConfigInfo |
object |
進階配置資訊 |
|
| configMetaName |
string |
索引配置名稱 |
index_meta_name |
| version |
integer |
版本號碼。 |
1.0 |
| lackMemWorker |
array |
因缺少記憶體而失敗的 worker 的 name |
|
|
string |
失敗的 worker 的 name |
test-fail-worker |
|
| deployFailedWorker |
array |
因部署失敗而失敗的 worker 的 name |
|
|
string |
失敗的 worker 的 name |
test-fail-worker |
|
| lackDiskWorker |
array |
因缺少磁碟而失敗的 worker 的 name |
|
|
string |
失敗的 worker 的 name |
test-fail-worker |
|
| errorMsg |
string |
錯誤資訊。 |
0A3B1C48006A6C0905F6375F4821EB50 |
| indexSize |
integer |
索引長度 |
100 |
| name |
string |
節點名稱 |
ha-cn-pl32rf0****_qrs |
| totalSize |
integer |
總大小 |
1 |
| doneSize |
integer |
完成大小 |
100 |
| donePercent |
integer |
總共完成的進度 |
100 |
| serviceStatus |
object |
服務狀態。 |
|
| name |
string |
名稱 |
ha-cn-pl32rf0****_qrs |
| totalSize |
integer |
叢集總節點數 |
100 |
| doneSize |
integer |
叢集處理中的節點數。 |
100 |
| donePercent |
integer |
總共完成進度 |
100 |
| configStatusList |
array<object> |
配置狀態列表 |
|
|
object |
響應體 |
||
| configUpdateTime |
string |
叢集更新時間 |
2024-05-21 16:05:26 |
| name |
string |
叢集名稱 |
test_0704 |
| totalSize |
integer |
總大小 |
0 |
| doneSize |
integer |
完成大小 |
1 |
| donePercent |
integer |
總共完成的進度 |
100 |
返回樣本
正確返回
{
"requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
"result": [
{
"clusterName": "",
"queryNode": {
"serviceStatus": {
"name": "service_name",
"totalSize": 1,
"doneSize": 1,
"donePercent": 100
},
"configStatusList": [
{
"name": "default",
"totalSize": 1,
"doneSize": 1,
"donePercent": 100,
"configUpdateTime": ""
}
]
},
"dataNodes": [
{
"serviceStatus": {
"name": "service_name",
"totalSize": 1,
"doneSize": 1,
"donePercent": 100
},
"configStatusList": [
{
"name": "default",
"totalSize": 1,
"doneSize": 1,
"donePercent": 100,
"configUpdateTime": ""
}
],
"dataStatusList": [
{
"name": "index1",
"totalSize": 1,
"doneSize": 1,
"donePercent": 100,
"docSize": 123423,
"fullVersion": 123423,
"incVersion": 123423,
"incUpdateTime": "",
"fullUpdateTime": "",
"indexConfigInfo": {
"configMetaName": "index_meta_name",
"version": 13241234
},
"advanceConfigInfo": {
"configMetaName": "advance_meta_name",
"version": 13241234
},
"lackMemWorker": [
"worker1",
"worker2"
],
"deployFailedWorker": [
"worker3",
"worker4"
],
"lackDiskWorker": [
"worker5",
"worker6"
],
"errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
},
{
"name": "index1",
"totalSize": 1,
"doneSize": 1,
"donePercent": 100,
"docSize": 123423,
"fullVersion": 123423,
"incVersion": 123423,
"incUpdateTime": "",
"fullUpdateTime": "",
"indexConfigInfo": {
"configMetaName": "index_meta_name",
"version": 13241234
},
"advanceConfigInfo": {
"configMetaName": "advance_meta_name",
"version": 13241234
},
"lackMemWorker": [
"worker1",
"worker2"
],
"deployFailedWorker": [
"worker3",
"worker4"
],
"lackDiskWorker": [
"worker5",
"worker6"
],
"errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
}
]
}
]
}
]
}
樣本
正常返回樣本
JSON格式
{
"requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
"result": [
{
"clusterName": "vpc_hz_domain_1",
"queryNode": {
"serviceStatus": {
"name": "vpc_hz_domain_1\n",
"totalSize": 100,
"doneSize": 100,
"donePercent": 100
},
"configStatusList": [
{
"configUpdateTime": "2024-05-21 16:05:26",
"name": "vpc_hz_domain_1\n",
"totalSize": 6,
"doneSize": 100,
"donePercent": 100
}
]
},
"dataNodes": [
{
"dataStatusList": [
{
"docSize": 2,
"fullVersion": 1718846192,
"incVersion": 1718846192,
"incUpdateTime": "2024-05-21 16:05:26",
"fullUpdateTime": "2024-05-21 16:05:26",
"indexConfigInfo": {
"configMetaName": "index_meta_name",
"version": 0
},
"advanceConfigInfo": {
"configMetaName": "index_meta_name",
"version": 1
},
"lackMemWorker": [
"test-fail-worker\n"
],
"deployFailedWorker": [
"test-fail-worker\n"
],
"lackDiskWorker": [
"test-fail-worker"
],
"errorMsg": "0A3B1C48006A6C0905F6375F4821EB50",
"indexSize": 100,
"name": "ha-cn-pl32rf0****_qrs",
"totalSize": 1,
"doneSize": 100,
"donePercent": 100
}
],
"serviceStatus": {
"name": "ha-cn-pl32rf0****_qrs",
"totalSize": 100,
"doneSize": 100,
"donePercent": 100
},
"configStatusList": [
{
"configUpdateTime": "2024-05-21 16:05:26",
"name": "test_0704",
"totalSize": 0,
"doneSize": 1,
"donePercent": 100
}
]
}
]
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。