接口功能介绍
根据筛选条件查询各设备类型支持的监控项的列表。
接口约束
deviceType（设备类型）符合取值范围，具体见请求参数说明。
URI
GET /v4/monitor/query-monitor-items
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| deviceType | String | 否 | vm | 本参数表示设备类型。默认值为所有类型。取值范围：vm：云主机。bare_metal：裸金属。disk：云磁盘。scaling：弹性伸缩。traffic：共享带宽。eip：弹性IP。elb：负载均衡。listener：监听器。cstor_sfs：弹性文件。site_monitor：站点监控。natgw：NAT网关。zos_bucket：对象存储-存储桶。zos_user：对象存储-用户。vnet_monitor_endpoint_statistic：VPC终端节点。vnet_endpoint_service_statistic：VPC终端节点服务。根据以上范围取值。 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| monitorItems | Array of Objects | 监控资源列表 | monitorItem |
表monitorItem
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deviceType | String | 监控设备类型 | vm | |
| items | Array of Objects | 监控设备指标内容 | items |
表items
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 监控指标名称 | cpu_util | |
| desc | String | 监控指标描述 | CPU使用率 | |
| unit | String | 指标单位 | % |
请求示例
GET /v4/monitor/query-monitor-items?deviceType=vm
响应示例
{
"statusCode":800,
"returnObj":{
"monitorItems":[
{
"deviceType":"vm",
"items":[
{
"name":"cpu_util",
"desc":"CPU使用率",
"unit":"%"
},
{
"name":"mem_util",
"desc":"内存使用率",
"unit":"%"
}
]
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.DeviceType.Unknown | 未知设备类型 |
| 其他 | 参见公共错误码说明 |
