接口功能介绍
调用此接口可查询用户资源分组列表。
接口约束
资源分组存在。
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 | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
