资源分组
资源分组：查询详情
接口功能介绍
调用此接口可查询指定资源分组详情。
接口约束
参见请求参数说明。
URI
GET /v4.1/monitor/describe-resource-group
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resGroupID | 是 | String | 资源分组ID | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | |
| service | 否 | String | 云监控服务，具体服务参见云监控：查询服务维度及监控项 | ecs | |
| dimension | 否 | String | 云监控维度，具体维度参见云监控：查询服务维度及监控项 | ecs | |
| instance | 否 | String | 对resource.value具体资源进行模糊查询 | 2e8ad126-3f08-11ed-95a4-acde48001122 |
请求参数
请求头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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| resGroupID | String | 资源分组ID | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | |
| createType | String | 本参数表示创建方式。取值范围：instance：实例创建。根据以上范围取值。 | instance | |
| name | String | 名称 | group_name | |
| desc | String | 描述 | 描述 | |
| alarmStatus | Integer | 本参数表示状态。取值范围： 0：未配置告警规则。1：有告警规则但未告警。2：告警中。根据以上范围取值。 | 0 | |
| 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/describe-resource-group?resGroupID=95f7f0cb-b5d7-547e-8667-3fceeab177d5
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"resGroupID": "c8c4df5b-d250-5029-8047-673ede4da229",
"name": "vm_res_group",
"desc": "this is a desc",
"createType": "instance",
"resourceList": [
{
"resources": [
{
"resource": [
{
"name": "instancename",
"value": "ecm2"
},
{
"name": "uuid",
"value": "2e8ad126-3f08-11ed-95a4-acde48001122"
}
],
"status": 0
}
],
"service": "ecs",
"dimension": "ecs",
"resourcesTotal": 1,
"alarmNum": 0
}
],
"alarmStatus": 0,
"totalAlarm": 0,
"totalRule": 0,
"totalResource": 1,
"totalResourceType": 1,
"createTime": 1723172129,
"updateTime": 1723195098
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.ResourceGroup.ResourceGroupNotExist | 资源分组不存在 |
| 其他 | 参见公共错误码说明 |
