查詢資源分組詳情
更新時間 2023-07-19 11:41:05
最(zui)近更新(xin)時間: 2023-07-19 11:41:05
分享文(wen)章(zhang)
接口功能介紹
調用此接口可查詢指定(ding)資源(yuan)分組的(de)資源(yuan)詳情(qing)。
接口約束
資源分組存在。
URI
GET /v4/monitor/query-resource-group-detail
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| resGroupID | String | 是 | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | 分組ID | |
| deviceType | String | 否 | vm | 本參數表示設備類型。取值范圍：vm：云主機。ph：宿主機。bare_metal：裸金屬。disk：云磁盤。scaling：彈性伸縮。traffic：共享帶寬。eip：彈性IP。elb：負載均衡。listener：監聽器。cstor_sfs：彈性文件。site_montior：站點監控。...詳見“告警規則：獲取告警設備類型列表”接口返回。 | |
| service | String | 否 | ecs | 本參數表示服務。取值范圍：ecs：云主機。evs：云硬盤。pms：物理機。...詳見“告警規則：獲取告警服務列表”接口返回。 | |
| instanceID | String | 否 | 2e8ad126-3f08-11ed-95a4-acde48001122 | 設備ID | |
| page | String | 否 | 1 | 頁碼，默認1,建議使用pageNo，該參數后續會下線 | |
| pageNo | String | 否 | 1 | 頁碼，默認為1 | |
| pageSize | String | 否 | 10 | 每頁數量，默認10 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回參數 | returnObj |
表(biao)returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| result | Array of Objects | 返回用戶的資源分組列表 | res | |
| totalCount | Integer | 總記錄數 | 20 | |
| currentCount | Integer | 當前頁記錄數 | 10 | |
| totalPage | Integer | 總頁數 | 2 |
表res
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ID | String | 資源ID | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | |
| service | String | 服務 | ecs | |
| instanceID | String | 設備ID | 2e8ad126-3f08-11ed-95a4-acde48001122 | |
| instanceName | String | 資源名稱 | test | |
| deviceUUID | String | 與監控對應的設備UUID | 2e8ad126-3f08-11ed-95a4-acde48001122 | |
| deviceType | String | 監控對應的設備類型 | vm |
請求示例
GET /v4/monitor/query-resource-group-detail
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"resGroupID": "95f7f0cb-b5d7-547e-8667-3fceeab177d5",
"page": 1,
"pageSize": 1
}
響應示例
{
"statusCode":800,
"returnObj": {
"result": [{
"ID": "c54fbde1-338e-56d5-a56a-e525405b0fae",
"service": "evs",
"instanceID": "2e8ad126-3f08-11ed-95a4-acde480011223333",
"instanceName": "bbb",
"deviceUUID": "xxxxxxxb",
"deviceType": "disk"
}],
"totalCount": 2,
"currentCount": 1,
"totalPage": 2
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
