接口功能介绍
查询物理机指定时间段内的磁盘监控数据
接口约束
无
URI
GET /v4/ebm/monitor_history_disk_metric
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 是 | String | 可用区名称或者 default。您可以调用 https://www.ctyun.cn/document/10026730/10040590 获取资源池信息，查询结果中zoneList内返回可用区名称，若查询结果中zoneList为空，即为单可用区，本字段填写default | az1 | |
| instanceUUID | 是 | String | 实例uuid | ss-vukvrtktafkyovqojz811e3izvhc | |
| startTime | 是 | Integer | 监控起始时间(unix秒时间戳) | 1666918163 | |
| endTime | 是 | Integer | 监控结束时间(unix秒时间戳) | 1666921763 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebm.MonitorHistoryDiskMetric.NotValid | |
| message | String | 响应结果的描述，一般为英文描述 | error request | |
| description | String | 响应结果的描述，一般为中文描述 | 错误请求 | |
| returnObj | Object | 返回参数，参考表returnObj | {} | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Array of Objects | 返回数据结果 | result |
表result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceUUID | String | 唯一键 | ss-93lyqzfoo5yydbaxrbvvgs9zqr3b | |
| fuserLastUpdated | String | 用户最近更新时间 | 2022-10-31 11:38:51 | |
| itemAggregateList | Object | 监控项值列表 | {} | itemAggregateList |
表itemAggregateList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| diskWriteRequestsRate | Array of Objects | 磁盘每秒写入请求次数监控列表 | diskWriteRequestsRate | |
| diskReadRequestsRate | Array of Objects | 磁盘每秒读取请求次数监控列表 | diskReadRequestsRate | |
| diskWriteBytesRate | Array of Objects | 磁盘写入速率监控列表 | diskWriteBytesRate | |
| diskReadBytesRate | Array of Objects | 磁盘读取速率监控列表 | diskReadBytesRate | |
| diskUtil | Array of Objects | 磁盘使用率监控列表 | diskUtil |
表diskWriteRequestsRate
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| samplingTime | Integer | 监控获取时间 | 1667456108 | |
| value | String | 磁盘每秒写入请求次数 | 1 |
表diskReadRequestsRate
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| samplingTime | Integer | 监控获取时间 | 1667456108 | |
| value | String | 磁盘每秒读取请求次数 | 0 |
表diskWriteBytesRate
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| samplingTime | Integer | 监控获取时间 | 1667456108 | |
| value | String | 磁盘写入速率(kb/s) | 1.99 |
表diskReadBytesRate
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| samplingTime | Integer | 监控获取时间 | 1667456108 | |
| value | String | 磁盘读取速率(kb/s) | 0 |
表diskUtil
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| samplingTime | Integer | 监控获取时间 | 1667456108 | |
| value | String | 磁盘使用率(0-100) | 2.42 |
请求示例
Query
/openapi/v4/ebm/monitor_history_disk_metric?regionID=bb9fdb42056f11eda1610242ac110002&azName=az1&instanceUUID=ss-h5bppzxnmfyy0szqk1yrb3esglin&endTime=1666921763&startTime=1666918163
响应示例
{
"returnObj": {
"result": [{
"itemAggregateList": {
"diskUtil": [{
"samplingTime": 1667456108,
"value": "2.42"
}, {
"samplingTime": 1667456408,
"value": "2.42"
}, {
"samplingTime": 1667456708,
"value": "2.42"
}, {
"samplingTime": 1667457008,
"value": "2.42"
}, {
"samplingTime": 1667457308,
"value": "2.42"
}],
"diskWriteBytesRate": [{
"samplingTime": 1667456108,
"value": "1.99"
}, {
"samplingTime": 1667456408,
"value": "0"
}, {
"samplingTime": 1667456708,
"value": "0"
}, {
"samplingTime": 1667457008,
"value": "0"
}, {
"samplingTime": 1667457308,
"value": "0"
}],
"diskWriteRequestsRate": [{
"samplingTime": 1667456108,
"value": "1"
}, {
"samplingTime": 1667456408,
"value": "0"
}, {
"samplingTime": 1667456708,
"value": "0"
}, {
"samplingTime": 1667457008,
"value": "0"
}, {
"samplingTime": 1667457308,
"value": "2"
}],
"diskReadBytesRate": [{
"samplingTime": 1667456108,
"value": "0"
}, {
"samplingTime": 1667456408,
"value": "0"
}, {
"samplingTime": 1667456708,
"value": "0"
}, {
"samplingTime": 1667457008,
"value": "0"
}, {
"samplingTime": 1667457308,
"value": "0"
}],
"diskReadRequestsRate": [{
"samplingTime": 1667456108,
"value": "0"
}, {
"samplingTime": 1667456408,
"value": "0"
}, {
"samplingTime": 1667456708,
"value": "0"
}, {
"samplingTime": 1667457008,
"value": "0"
}, {
"samplingTime": 1667457308,
"value": "0"
}]
},
"instanceUUID": "ss-h5bppzxnmfyy0szqk1yrb3esglin",
"fuserLastUpdated": "2022-11-03 14:40:38"
}]
},
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.MonitorHistoryDiskMetric.NotValid | 请求参数非法 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| 其他 | 参见公共错误码说明 |
