資源分組：列表查詢v4.1
更新時間 2024-11-29 18:48:10
最近更新時間: 2024-11-29 18:48:10
分享文章
資源分組
資源分組：查詢列表
接口功能介紹
調用此接口可查詢用戶資源分組列表。
接口約束
參見請求參數說明。
URI
GET /v4.1/monitor/query-resource-groups
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 否 | String | 名稱模糊搜索 | group_name | |
| resGroupID | 否 | String | 資源分組ID搜索 | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | |
| pageNo | 否 | Integer | 頁碼，默認為1 | 1 | |
| pageSize | 否 | Integer | 每頁數量，默認10 | 10 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| resGroupList | Array of Objects | 返回用戶的資源分組列表 | resGroup | |
| resGroupQuota | Integer | 資源分組配額剩余數量 | 8 | |
| totalCount | Integer | 總記錄數 | 20 | |
| currentCount | Integer | 當前頁記錄數 | 10 | |
| totalPage | Integer | 總頁數 | 2 |
表 resGroup
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| regionID | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| resGroupID | String | 資源分組ID | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | |
| name | String | 名稱 | group_name | |
| createType | String | 本參數表示創建方式。取值范圍：instance：實例創建。根據以上范圍取值。 | instance | |
| desc | String | 描述 | 描述 | |
| updateTime | Integer | 最近更新時間，時間戳，秒級 | 1716455810 | |
| createTime | Integer | 創建時間，時間戳，秒級 | 1716455810 | |
| resourceList | Array of Objects | 資源列表 | resourceListObj | |
| alarmStatus | Integer | 本參數表示狀態。取值范圍：0：未配置告警規則。1：有告警規則但未告警。2：告警中。根據以上范圍取值。 | 0 | |
| totalAlarm | Integer | 資源分組的告警資源總數 | 0 | |
| totalRule | Integer | 資源分組的規則數 | 2 | |
| totalResource | Integer | 資源分組的的資源總數 | 20 | |
| totalResourceType | Integer | 資源分組的資源類型數 | 5 |
表 resourceListObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| service | String | 云監控服務，具體服務參見云監控：查詢服務維度及監控項 | ecs | |
| dimension | String | 云監控維度，具體維度參見云監控：查詢服務維度及監控項 | ecs | |
| resourcesTotal | Integer | 某一類型下資源總數 | 3 | |
| alarmNum | Integer | 某一類型下告警中的資源總數 | 2 | |
| resources | Array of Objects | 資源信息列表 | resources |
表 resources
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| resource | Array of Objects | 資源信息 | resourceObj | |
| status | Integer | 本參數表示具體資源是否告警。取值范圍：0：正常。1：告警。根據以上范圍取值。 | 0 |
表 resourceObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 實例標簽名 | uuid | |
| value | String | 實例標簽對應的值，無效值將無法正常產生告警。 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 |
請求示例
請求url
/v4.1/monitor/query-resource-groups?regionID=81f7728662dd11ec810800155d307d5b
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"returnObj": {
"resGroupList": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"resGroupID": "acda5922-526a-5482-bd1a-ed13da9d1a54",
"name": "vm_res_group",
"desc": "this is desc",
"createType": "instance",
"resourceList": [
{
"resources": [
{
"resource": [
{
"name": "instancename",
"value": "ecm1"
},
{
"name": "uuid",
"value": "2e8ad126-3f08-11ed-95a4-acde48001100"
}
],
"status": 0
}
],
"service": "ecs",
"dimension": "ecs",
"resourcesTotal": 1,
"alarmNum": 0
}
],
"alarmStatus": 0,
"totalAlarm": 0,
"totalRule": 0,
"totalResource": 1,
"totalResourceType": 1,
"createTime": 1723172129,
"updateTime": 1723195098
}
],
"totalPage": 1,
"totalCount": 1,
"currentCount": 1,
"resGroupQuota": 6
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
