监控概览
查询云主机监控：CPU使用率Top-N
接口功能介绍
调用此接口可查询用户在指定资源池云主机监控中cpu使用率Top-N。
接口约束
regionID（资源池）存在。
URI
POST /v4/monitor/query-cpu-top
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| number | 否 | Integer | 选取TOP值的数量，不传默认为3，当传入值或默认值超过用户实际拥有的资源数量，以用户的实际资源数量为准 | 3 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| cpuList | Array of Objects | cpu利用率列表 | cpu |
表 cpu
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deviceID | String | 设备ID | 3080069a-ca2b-fca1-f038-5e6e00dd7630 | |
| name | String | 设备名字 | ecm-be47 | |
| value | String | cpu利用率的值 | 0.5669 |
请求示例
请求url
/v4/monitor/query-cpu-top
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"number":3
}
响应示例
{
"statusCode":800,
"returnObj":{
"cpuList":[
{
"deviceID":"3080069a-ca2b-fca1-f038-5e6e00dd7630",
"name":"ecm-be47",
"value":"0.5669"
},
{
"deviceID":"0582fe3b-97bd-ac16-2b88-1c1a84fe89ce",
"name":"ecm-69c1",
"value":"0.467"
},
{
"deviceID":"b7862cdf-6b1b-bdfd-8410-ba71d2a7ecb8",
"name":"ecm-71e7",
"value":"0.4503"
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| 其他 | 参见公共错误码说明 |
