資源分組列表查詢
更新時間 2023-07-19 11:41:05
最近更新時間: 2023-07-19 11:41:05
分享文章
接口功能介紹
調用(yong)(yong)此接口可查詢用(yong)(yong)戶(hu)資源分(fen)組(zu)列表。
接口約束
資源分組存在。
URI
GET /v4/monitor/query-resource-group
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| resGroupID | String | 否 | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | 分組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 |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| result | Array of Objects | 返回用戶的資源分組列表 | res | |
| totalCount | Integer | 總記錄數 | 20 | |
| currentCount | Integer | 當前頁記錄數 | 10 | |
| totalPage | Integer | 總頁數 | 2 |
表res
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| resGroupID | String | 分組ID | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | |
| name | String | 名稱 | test | |
| desc | String | 描述 | 描述 | |
| regionID | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| status | Integer | 本參數表示狀態值。取值范圍：0：未設置告警規則。1：無告警。2：告警中。根據以上范圍取值。 | 0 | |
| ruleTotal | Integer | 規則數 | 0 | |
| lastChange | String | 更新時間 | 2022-11-09T08:19:24Z |
請求示例
GET /v4/monitor/query-resource-group
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"resGroupID": "7d8cb36a-a965-52fa-b1da-bcbae776bb16"
}
響應示例
{
"statusCode":800,
"returnObj": {
"result": [{
"resGroupID": "7d8cb36a-a965-52fa-b1da-bcbae776bb16",
"name": "testupdate",
"desc": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"status": 0,
"ruleTotal":0,
"lastChange": "2023-04-11T12:32:17Z"
}],
"totalCount": 1,
"currentCount": 1,
"totalPage": 1
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
