实例监控数据查询
更新时间：2023-03-10 14:16:52
适用产品
边缘云主机
接口描述
查询云主机实例的CPU使用率、内存使用情况和带宽使用情况，以便接入自身的监控系统，掌控云主机的运行情况。提供近90天的监控数据查询，单次查询范围不超过3天，数据粒度为5分钟。如果是裸机实例，当前仅支持查询带宽，不支持查询CPU和内存。
- 调用URL： https://open.chinanetcenter.com/vmp/servers/metric
- 调用方法：GET
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Params 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
ids | String | 是 | 云主机ID。单次最多查询 20 条 ID，ID 之间用半角逗号字符','隔开。 |
type | String | 是 | 查询的监控数据类型，取值： cpu： cpu使用率 mem：内存 bandwidth：流量数据 |
statTime | String | 是 | 查询时间范围，格式：yyyyMMddHHmm- yyyyMMddHHmm 查询近90天的数据，单次查询不超过3天。 例如：202001201730-202001201930表示查询2020-01-20 17:30到19:30的监控数据。 |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
servers | 实例信息数组 | |
id | 实例唯一标识 | |
bandwidths | 带宽信息 | |
statTime | 带宽采集时间，格式yyyyMMddHHmm，为5分钟粒度 | |
out | 总流出带宽（含节点内流量），单位Mbps | |
in | 总流入带宽（含节点内流量），单位Mbps | |
extIn | 外网流入带宽（不含节点内流量），单位Mbps | |
extOut | 外网流出带宽（不含节点内流量），单位Mbps | |
mems | 内存信息 | |
statTime | 内存数据采集时间，格式yyyyMMddHHmm，为5分钟粒度 | |
used | 内存使用量，单位为MB | |
total | 总内存量，单位为MB | |
cpus | CPU信息 | |
statTime | cpu使用率采集时间，格式yyyyMMddHHmm，为5分钟粒度 | |
usage | cpu使用率，取值0-1，如0.25，该值则表示使用率为25% |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| 26033002 | 虚拟机监控信息查询错误码 | 500 |
示例
JSON
- 请求示例 复制成功
1、Bandwidth Request Example: GET /servers/metric?ids=5b5cb35bbcc803193ca1494f87a05c63,4c64801ec141426bb973bd0d09cd62f8&type=bandwidth&statTime=202001200950-202001210950 2、Memory Request Example: GET /servers/metric?ids=5b5cb35bbcc803193ca1494f87a05c63,4c64801ec141426bb973bd0d09cd62f8&type=mem&statTime=202001200950-202001210950 3、CPU Request Example: GET /servers/metric?ids=5b5cb35bbcc803193ca1494f87a05c63,4c64801ec141426bb973bd0d09cd62f8&type=cpu&statTime=202001200950-202001210950
- 返回示例 复制成功
1、带宽响应示例： { "servers": [ { "id": "5b5cb35bbcc803193ca1494f87a05c63", "bandwidths": [ { "in": "0.03", "out": "0.00", "extIn": "0.03", "extOut": "0.00", "statTime": "202001200950" }, { "in": "0.03", "out": "0.00", "extIn": "0.03", "extOut": "0.00", "statTime": "202001200955" } ] }, { "id": "4c64801ec141426bb973bd0d09cd62f8 ", "bandwidths": [ { "in": "2.49", "out": "0.14", "extIn": "2.42", "extOut": "0.10", "statTime": "202001200950" }, { "in": "0.49", "out": "0.04", "extIn": "0.49", "extOut": "0.04", "statTime": "202001200955" } ] } ] } 2、内存响应示例： { "servers": [ { "id": "5b5cb35bbcc803193ca1494f87a05c63", "mems": [ { "statTime": "202001200950", "total": "3791.00", "used": "3580.40" }, { "statTime": "202001200955", "total": "3791.00", "used": "3581.00" } ] }, { "id": "4c64801ec141426bb973bd0d09cd62f8", "mems": [ { "statTime": "202001200950", "total": "3791.00", "used": "2678.80" }, { "statTime": "202001200955", "total": "3791.00", "used": "2738.00" } ] } ] } 3、CPU响应实例： { "servers": [ { "id": "5b5cb35bbcc803193ca1494f87a05c63", "cpus": [ { "statTime": "202001200950", "usage": "0.11" }, { "statTime": "202001200955", "usage": "0.90" } ] }, { "id": "4c64801ec141426bb973bd0d09cd62f8", "cpus": [ { "statTime": "202001200950", "usage": "0.21" }, { "statTime": "202001200955", "usage": "0.26" } ] } ] }
本篇文档内容对您是否有帮助？
有帮助
我要反馈