接口功能介绍
查询单个用户在某个资源池下某种设备类型的监控指标由高到低的顺序
接口约束
regionID（资源池）、deviceUUIDList（设备资源）、itemNameList（待查监控项名称）存在。
URI
POST /v4/monitor/query-metricdata-top
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| deviceType | String | 是 | vm | 本参数表示设备类型，目前仅支持云主机。取值范围：vm：云主机。根据以上范围取值。 | |
| itemNameList | Array of String | 是 | ["disk_util"] | 待查的监控项名称 | |
| deviceUUIDList | Array of String | 否 | ["3080069a-ca2b-fca1-f038-5e6e00dd7630"] | 查询设备ID列表，不传默认返回该用户下指定类型的所有设备 | |
| number | Integer | 否 | 2 | 返回用户在该资源池下某个设备类型监控值最大的前N个设备信息，默认为5 | |
| pageNo | Integer | 否 | 1 | 页码，默认为1 | |
| page | Integer | 否 | 1 | 页码，默认为1，建议使用pageNo，该参数后续会下线 | |
| pageSize | Integer | 否 | 2 | 页大小，默认为20 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Array of Objects | 返回数据结果 | result | |
| totalCount | Integer | 获取对象数据条数 | 14 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前页记录数 | 14 | |
| page | Integer | 页码，建议参考请求参数pageNo，该参数后续会下线 | 1 | |
| pageSize | Integer | 页大小，建议参考请求参数pageSize，该参数后续会下线 | 10 |
表result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deviceType | String | 设备类型 | vm | |
| regionID | String | 所属资源池ID | 81f7728662dd11ec810800155d307d5b | |
| regionName | String | 资源池名称 | nm8 | |
| fuserLastUpdated | String | 最近更新时间 | 2022-11-07 18:25:12 | |
| itemList | Array of Objects | 返回监控项列表 | itemList |
表itemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| {itemName} | String | 监控项名称 | disk_util | |
| {deviceInfoList} | Array of Objects | 设备信息取值数组 | deviceInfoList |
表deviceInfoList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deviceUUID | String | 设备uuid | 3080069a-ca2b-fca1-f038-5e6e00dd7630 | |
| samplingTime | Integer | 监控数据采样时间 | 1667815639 | |
| value | Double | 监控项值，具体请参考对应监控项文档 | 524288 |
请求示例
POST /v4/monitor/query-metricdata-top
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"deviceType":"vm",
"itemNameList": [
"disk_util",
"cpu_util",
"mem_util"
],
"number":2
}
响应示例
{
"statusCode":800,
"returnObj":{
"result":[
{
"deviceType":"vm",
"fuserLastUpdated":"2022-10-20 10:11:46",
"regionID":"73f321ea-62ff-11ec-a8bc-005056898fe0",
"regionName":"nm8",
"itemsList":[
[
{
"disk_util":[
{
"deviceUUID":"3080069a-ca2b-fca1-f038-5e6e00dd7630",
"name":"ecm-be47",
"value":"46.7587"
},
{
"deviceUUID":"b7862cdf-6b1b-bdfd-8410-ba71d2a7ecb8",
"name":"ecm-71e7",
"value":"46.7581"
}
]
},
{
"cpu_util":[
{
"deviceUUID":"b7862cdf-6b1b-bdfd-8410-ba71d2a7ecb8",
"name":"ecm-71e7",
"value":"0.6501"
},
{
"deviceUUID":"3080069a-ca2b-fca1-f038-5e6e00dd7630",
"name":"ecm-be47",
"value":"0.5505"
}
]
},
{
"mem_util":[
{
"deviceUUID":"b7862cdf-6b1b-bdfd-8410-ba71d2a7ecb8",
"name":"ecm-71e7",
"value":"81.1625"
},
{
"deviceUUID":"43eaf44d-aa29-ceee-7ac1-32d3251b3c29",
"name":"as-config-82abuz79",
"value":"80.185"
}
]
}
]
]
}
],
"totalCount": 4,
"currentCount": 4,
"totalPage": 1,
"page": 1,
"pageSize": 20
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.DataQuery.AccessFailed | 访问内部系统失败 |
| Monitor.DataQuery.ResponseError | 访问内部系统返回错误 |
| 其他 | 参见公共错误码说明 |
