接口功能介绍
查询云主机的磁盘实时监控数据
接口约束
- 调用接口时，如果监控项返回的值为"-1"则说明未获取到监控项
URI
POST /v4/ecs/vm-disk-latest-metric-data
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 必传参数regionID | 100054c0416811e9a6690242ac110002 | |
| deviceIDList | 是 | Array of Strings | 必传参数，云主机ID，如果不传，返回所有 | ["9d8a3ea2-add5-c0b6-204a-9e1d0d44e843","86ed9b03efa82ee1515db84bb388fffe"] | |
| pageNo | 否 | Integer | 可选参数，值>=1, 不传默认为1 | 1 | |
| page | 否 | Integer | 可选参数，值>=1, 不传默认为1, 建议使用pageNo，该参数后续会下线 | 1 | |
| pageSize | 否 | Integer | 可选参数，值>=1,不传默认为20 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码状态(800为成功，900为失败)，默认值：800 | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败或成功时的描述，一般为英文描述 | Success | |
| msgDesc | String | 失败或成功时的描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数，参考表returnObj | returnObj | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Array of Objects | result对象 | result | |
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| pageSize | Integer | 总记录数,建议使用totalCount，该参数后续会下线 | 10 | |
| page | Integer | 总页数,建议使用totalPage，该参数后续会下线 | 1 |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| fUID | String | 唯一键 | bf9513ac-0ad6-fcb1-623c-4c4a0252483d | |
| fuserLastUpdated | String | 用户最近更新时间 | 2022-11-07 15:54:12 | |
| regionID | String | 资源池ID | 73f321ea-62ff-11ec-a8bc-005056898fe0 | |
| deviceUUID | String | 云主机ID | bf9513ac-0ad6-fcb1-623c-4c4a0252483d | |
| extendStatus | Integer | 监控粒度开启状态，无(-1),开启(0),关闭(1) | 1 | |
| itemList | Object | 监控项值列表 | itemList |
表 itemList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| samplingTime | Integer | 监控获取时间 | 1667807652 | |
| disk_read_bytes_rate | String | 磁盘读速率（byte/s） | 0 | |
| disk_read_requests_rate | String | 磁盘读操作速率（请求/秒） | 0 | |
| disk_write_requests_rate | String | 磁盘写操作速率（请求/秒） | 0.667 | |
| disk_util | String | 磁盘分配率 (%) | 3.6585 | |
| disk_write_bytes_rate | String | 磁盘写速率（byte/s） | 0.2167 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"deviceIDList": [
"bf9513ac-0ad6-fcb1-623c-4c4a0252483d"
]
}
响应示例
{
"returnObj": {
"totalCount": 1,
"result": [
{
"extendStatus": 1,
"regionID": "73f321ea-62ff-11ec-a8bc-005056898fe0",
"fUID": "bf9513ac-0ad6-fcb1-623c-4c4a0252483d",
"deviceUUID": "bf9513ac-0ad6-fcb1-623c-4c4a0252483d",
"fuserLastUpdated": "2022-11-07 19: 37: 55",
"itemList": {
"disk_read_requests_rate": "0",
"samplingTime": 1667821075,
"disk_write_requests_rate": "0",
"disk_write_bytes_rate": "0",
"disk_read_bytes_rate": "0",
"disk_util": "6.96"
}
}
],
"currentCount": 1,
"totalPage": 1,
"pageSize": 1,
"page": 1
},
"errorCode": "",
"message": "SUCCESS",
"msgDesc": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
