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