接口功能介绍
查询裸金属设备的实时监控数据。
接口约束
regionID（资源池）存在，且存在裸金属设备。
URI
POST /v4/monitor/query-baremetal-latestmetricdata
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| deviceUUIDList | Array of String | 是 | ["ss-i30bdlsblz67tapnhg9jecuyzp5d"] | 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID | |
| pageNo | Integer | 否 | 1 | 页码，默认为1 | |
| page | Integer | 否 | 1 | 页码，默认为1，建议使用pageNo，该参数后续会下线 | |
| pageSize | Integer | 否 | 1 | 页大小，默认为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 | 获取对象数据条数 | 138 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前页记录数 | 2 | |
| page | Integer | 页码，建议参考请求参数pageNo，该参数后续会下线 | 1 | |
| pageSize | Integer | 页大小，建议参考请求参数pageSize，该参数后续会下线 | 10 |
表result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 所属资源池ID | 81f7728662dd11ec810800155d307d5b | |
| fUID | String | 唯一键 | ss-i30bdlsblz67tapnhg9jecuyzp5d | |
| fuserLastUpdated | String | 最近更新时间 | 2022-11-07 18:25:12 | |
| deviceUUID | String | 设备ID | ss-i30bdlsblz67tapnhg9jecuyzp5d | |
| itemList | Object | 监控项内容 | itemList |
表itemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| samplingTime | Integer | 监控数据采集时间 | 1667816712 | |
| {item1} | String | 监控项具体内容 | 0.1168 | |
| {item2} | String | 监控项具体内容 | 0.1168 | |
| ... | String | 监控项具体内容 |
请求示例
POST /v4/monitor/query-baremetal-latestmetricdata
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"deviceUUIDList": [
"ss-i30bdlsblz67tapnhg9jecuyzp5d"
],
"pageNo": 1,
"pageSize": 5
}
响应示例
{
"statusCode":800,
"returnObj":{
"result":[
{
"regionID":"73f321ea-62ff-11ec-a8bc-005056898fe0",
"fUID":"ss-i30bdlsblz67tapnhg9jecuyzp5d",
"fuserLastUpdated":"2022-10-20 15:57:08",
"deviceUUID":"ss-i30bdlsblz67tapnhg9jecuyzp5d",
"itemList":{
"disk_util":"3.5",
"cpu_util":"3.23",
"mem_util":"0.79",
"disk_read_bytes_rate":"0",
"disk_write_bytes_rate":"0",
"disk_read_requests_rate":"0",
"disk_write_requests_rate":"0",
"net_in_bytes_rate":"46553829.94",
"net_out_bytes_rate":"238130.41",
"samplingTime":1666252628
}
}
],
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"page": 1,
"pageSize": 5
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.DataQuery.RegionNotFound | 找不到资源池 |
| Monitor.DataQuery.ItemNameUndefined | 监控项未定义 |
| Monitor.DataQuery.QueryError | 查询数据失败 |
| Monitor.DataQuery.AccessFailed | 访问内部系统失败 |
| Monitor.DataQuery.ResponseError | 访问内部系统返回错误 |
| 其他 | 参见公共错误码说明 |
