接口功能介绍
该接口提供用户查询指定时间段内的CPU监控数据的功能
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
当前查询结果以分页形式进行展示，单次查询最多显示50条数据
调用接口时，如果监控项返回的值为"[]"则说明未获取到监控项
接口约束
确保当前请求资源池下，该云主机存在（即deviceIDList真实存在且与regionID相对应）
URI
POST /v4/ecs/vm-cpu-history-metric-data
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
100054c0416811e9a6690242ac110002 | |
| deviceIDList | 是 | Array of Strings | 云主机ID列表，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
["9d8a3ea2-add5-c0b6-204a-9e1d0d44e843", "86ed9b03efa82ee1515db84bb388fffe"] | |
| period | 否 | Integer | 聚合周期，单位秒，注：默认值为300 | 14400 | |
| startTime | 是 | String | 必传参数，查询起始时间戳 | 1665305264 | |
| endTime | 是 | String | 必传参数，查询终止时间戳 | 1667441264 | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| page | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1，后续该字段可能废弃 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码状态(800为成功，900为失败)，默认值：800 | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败或成功时的描述，一般为英文描述 | Success | |
| msgDesc | String | 失败或成功时的描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数，参考表returnObj | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Array of Objects | result对象 | result | |
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| pageSize | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 | |
| page | Integer | 页码，取值范围：正整数（≥1），注：默认值为1，后续该字段可能废弃 | 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 | |
| itemAggregateList | Object | 监控信息 | itemAggregateList |
表 itemAggregateList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| process_cpu_used | Array of Objects | 进程CPU使用率，下级对象中value的单位为（%） | itemValue | |
| cpu_util | Array of Objects | CPU使用率，下级对象中value的单位为（%） | itemValue | |
| cpu_user_time | Array of Objects | 用户空间CPU使用率，下级对象中value的单位为（%） | itemValue | |
| cpu_system_time | Array of Objects | 内核空间CPU使用率，下级对象中value的单位为（%） | itemValue | |
| cpu_interrupt_time | Array of Objects | CPU中断时间占比，下级对象中value的单位为（%） | itemValue | |
| cpu_iowait_time | Array of Objects | iowait状态占比，下级对象中value的单位为（%） | itemValue | |
| cpu_softirq_time | Array of Objects | CPU软中断时间占比，下级对象中value的单位为（%） | itemValue | |
| cpu_idle_time | Array of Objects | CPU空闲时间占比，下级对象中value的单位为（%） | itemValue | |
| other_cpu_util | Array of Objects | 其他CPU使用率，下级对象中value的单位为（%） | itemValue |
表 itemValue
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| value | String | 监控项值 | ||
| samplingTime | Integer | 监控获取时间 | 1667489264 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"pageNo": 1,
"pageSize": 2,
"deviceIDList": ["3c496231-8fe5-44b9-8d6b-6129f6e319a8","8887670d-34cd-432f-b977-aa1f62d2e13c"],
"startTime": "1667486264",
"endTime": "1667491264",
"period": 240
}
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [{
"regionID": "990ba31c22ec11eaaebd0242ac110002",
"fUID": "3c496231-8fe5-44b9-8d6b-6129f6e319a8",
"deviceUUID": "3c496231-8fe5-44b9-8d6b-6129f6e319a8",
"fuserLastUpdated": "2023-06-26 18:40:30",
"itemAggregateList": {
"cpu_util": [{
"value": "0.54",
"samplingTime": 1687082820
}, {
"value": "0.53",
"samplingTime": 1687083120
}, {
"value": "0.54",
"samplingTime": 1687083420
}, {
"value": "0.55",
"samplingTime": 1687083720
}, {
"value": "0.54",
"samplingTime": 1687084020
}, {
"value": "0.55",
"samplingTime": 1687084320
}, {
"value": "0.56",
"samplingTime": 1687084620
}, {
"value": "0.55",
"samplingTime": 1687084920
}, {
"value": "0.54",
"samplingTime": 1687085220
}, {
"value": "0.54",
"samplingTime": 1687085520
}, {
"value": "0.54",
"samplingTime": 1687085820
}, {
"value": "0.56",
"samplingTime": 1687086120
}],
"other_cpu_util": [{
"value": "0.0",
"samplingTime": 1687082820
}, {
"value": "0.0",
"samplingTime": 1687083120
}, {
"value": "0.0",
"samplingTime": 1687083420
}, {
"value": "0.0",
"samplingTime": 1687083720
}, {
"value": "0.0",
"samplingTime": 1687084020
}, {
"value": "0.0",
"samplingTime": 1687084320
}, {
"value": "0.0",
"samplingTime": 1687084620
}, {
"value": "0.0",
"samplingTime": 1687084920
}, {
"value": "0.0",
"samplingTime": 1687085220
}, {
"value": "0.0",
"samplingTime": 1687085520
}, {
"value": "0.0",
"samplingTime": 1687085820
}, {
"value": "0.0",
"samplingTime": 1687086120
}]
}
}, {
"regionID": "990ba31c22ec11eaaebd0242ac110002",
"fUID": "8887670d-34cd-432f-b977-aa1f62d2e13c",
"deviceUUID": "8887670d-34cd-432f-b977-aa1f62d2e13c",
"fuserLastUpdated": "2023-06-26 18:40:30",
"itemAggregateList": {
"cpu_util": [{
"value": "0.5",
"samplingTime": 1687082820
}, {
"value": "0.52",
"samplingTime": 1687083120
}, {
"value": "0.51",
"samplingTime": 1687083420
}, {
"value": "0.53",
"samplingTime": 1687083720
}, {
"value": "0.53",
"samplingTime": 1687084020
}, {
"value": "0.54",
"samplingTime": 1687084320
}, {
"value": "0.53",
"samplingTime": 1687084620
}, {
"value": "0.52",
"samplingTime": 1687084920
}, {
"value": "0.52",
"samplingTime": 1687085220
}, {
"value": "0.51",
"samplingTime": 1687085520
}, {
"value": "0.48",
"samplingTime": 1687085820
}, {
"value": "0.54",
"samplingTime": 1687086120
}],
"other_cpu_util": [{
"value": "0.0",
"samplingTime": 1687082820
}, {
"value": "0.0",
"samplingTime": 1687083120
}, {
"value": "0.0",
"samplingTime": 1687083420
}, {
"value": "0.0",
"samplingTime": 1687083720
}, {
"value": "0.0",
"samplingTime": 1687084020
}, {
"value": "0.0",
"samplingTime": 1687084320
}, {
"value": "0.0",
"samplingTime": 1687084620
}, {
"value": "0.0",
"samplingTime": 1687084920
}, {
"value": "0.0",
"samplingTime": 1687085220
}, {
"value": "0.0",
"samplingTime": 1687085520
}, {
"value": "0.0",
"samplingTime": 1687085820
}, {
"value": "0.0",
"samplingTime": 1687086120
}]
}
}],
"totalCount": 2,
"currentCount": 1,
"totalPage": 1,
"pageSize": 1,
"page": 1
},
"errorCode": "",
"message": "SUCCESS",
"msgDesc": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码
