历史监控数据：查询v4.2
更新时间 2026-03-25 16:55:09
最近更新时间: 2026-03-25 16:55:09
接口功能介绍
查询指定时间段内的设备时序指标监控数据。接口调用可参考帮助中心-云监控服务-最佳实践-通过云监控OpenAPI查询监控数据。
接口约束
参见请求参数说明。
URI
POST /v4.2/monitor/query-history-metric-data
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 是 | String | 云监控服务，具体服务参见云监控：查询服务维度及监控项 | ecs | |
| dimension | 是 | String | 云监控维度，具体维度参见云监控：查询服务维度及监控项 | ecs | |
| itemNameList | 是 | Array of Strings | 待查监控项名称，单次请求长度限制为10，具体设备对应监控项参见云监控：查询服务维度及监控项 | ['cpu_util','disk_write_bytes_rate'] | |
| startTime | 是 | Long | 查询起始Unix时间戳，秒级 | 1667815639 | |
| endTime | 是 | Long | 查询结束Unix时间戳，秒级 | 1667817639 | |
| fun | 是 | String | 本参数表示聚合类型。默认值为avg。取值范围: raw：原始值。 avg：平均值。 min：最小值。 max：最大值。 sum：求和。 根据以上范围取值。 | avg | |
| period | 否 | Integer | 聚合周期，单位：秒，默认300，需不小于60，推荐使用60的整倍数。当fun为raw时本参数无效。 | 300 | |
| dimensions | 是 | Array of Objects | 查询设备标签列表，用于定位要查询监控数据的目标设备，多标签查询取交集，单次请求设备数量限制为10 | dimension |
表 dimension
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 设备标签键，取值范围参考云监控：查询服务维度及监控项响应的dimensions字段。 以云主机为例，该字段为uuid。 | uuid | |
| value | 是 | Array of Strings | 设备标签键所对应的值，最大数量限制为10。 以云主机为例，该字段为云主机的instanceID。 | ['9dc48979-4e19-45e2-b523-5d3c70d516b3'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemList | Array of Objects | 监控项列表 | item |
表 item
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| itemName | String | 监控项名称 | cpu_util | |
| itemDesc | String | 监控项中文介绍 | CPU使用率 | |
| itemUnit | String | 监控项单位 | bit/s | |
| itemData | Array of Objects | 监控项内容 | itemData | |
| dimensions | Array of Objects | 监控项标签 | dimension | |
| unitRelations | Array of Objects | 单位转换字典 | unitRelation |
表 itemData
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| value | Double | 监控项值，具体请参考对应监控项文档 | 524288 | |
| timestamp | Long | 监控数据Unix时间戳 | 1667815639 |
表 dimension
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 监控项标签键 | uuid | |
| value | String | 监控项标签键对应的值 | 9dc48979-4e19-45e2-b523-5d3c70d516b3 |
表 unitRelation
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| unit | String | 单位 | % | |
| weight | Double | 权重 | 1 |
枚举参数
无
请求示例
请求url
/v4.2/monitor/query-history-metric-data
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"service":"ecs",
"dimension":"ecs",
"itemNameList":[
"cpu_util",
"disk_write_bytes_rate"
],
"startTime":1665305264,
"endTime":1665391665,
"fun":"avg",
"dimensions":[
{
"name":"uuid",
"value":[
"000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
]
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"itemList": [
{
"itemName": "cpu_util",
"itemDesc": "CPU使用率",
"itemUnit": "%",
"itemData": [
{
"value": 0.2002,
"timestamp": 1665338264
},
{
"value": 0.2002,
"timestamp": 1665338264
},
{
"value": 0.1835,
"timestamp": 1665365264
}
],
"dimensions": [
{
"name": "uuid",
"value": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
}
],
"unitRelations": [
{
"weight": 1,
"unit": "%"
},
{
"unit": "(0-1)",
"weight": 100
}
]
},
{
"itemName": "disk_write_bytes_rate",
"itemDesc": "磁盘写速率",
"itemUnit": "KB/s",
"itemData": [
{
"value": 0.4917,
"timestamp": 1665338264
},
{
"value": 0.4917,
"timestamp": 1665338264
},
{
"value": 1.075,
"timestamp": 1665365264
}
],
"dimensions": [
{
"name": "uuid",
"value": "000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
}
],
"unitRelations": [
{
"unit": "Byte/s",
"weight": 1
},
{
"unit": "KB/s",
"weight": 1024
},
{
"unit": "MB/s",
"weight": 1048576
},
{
"unit": "GB/s",
"weight": 1073741824
}
]
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码
