1. 接口描述
接口:GetMonitorData
获取云产品的监控数据。传入产品的命名空间、对象维度描述和监控指标即可获得相应的监控数据。
若您需要调用的指标、对象较多,可能存在因限频出现拉取失败的情况,建议尽量将请求按时间维度均摊。
查询块存储监控数据,入参取值如下:
namespace:qce/block_storage
dimensions.0.name=diskId
dimensions.0.value 为块存储 ID
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 文档。其中,此接口的 Action 字段为 GetMonitorData。
2.1 输入参数
参数名称 | 必选 | 类型 | 输入内容 | 描述 |
---|---|---|---|---|
namespace | 是 | String | qce/cvm | 命名空间,每个云产品会有一个命名空间,具体名称见输入内容一栏。 |
metricName | 是 | String | 具体的指标名称 | 指标名称,具体名称见 2.2 |
dimensions.0.name | 是 | String | diskId | 入参为块存储 ID |
dimensions.0.value | 是 | String | 块存储的具体 ID | 块存储 ID |
period | 否 | Int | 60/300 | 监控统计周期,绝大部分指标支持 60s 统计粒度,部分指标仅支持 300s 统计粒度,统计粒度根据指标的不同而变。输入参数时可参考 2.2 的指标详情列表。 |
startTime | 否 | Datetime | 起始时间 | 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的”00:00:00” |
endTime | 否 | Datetime | 结束时间 | 结束时间,默认为当前时间。 endTime 不能小于 startTime |
2.2 指标名称
每个指标的统计粒度(Period)可取值不一定相同,可通过 DescribeBaseMetrics 接口获取每个接口支持的统计粒度。
指标名称 | 指标中文名称 | 计算方式 | 指标含义 | 单位 | 统计粒度(period) |
---|---|---|---|---|---|
disk_read_iops | 硬盘读 IOPS | 块存储在统计周期内读IOPS的平均值 | 每秒从块存储读到内存中的 IO 次数 | 次数 | 10s、60s、300s |
disk_read_traffic | 硬盘读流量 | 块存储在统计周期内读吞吐量的平均值 | 数据从块存储读取到内存中的速率 | MB/s | 10s、60s、300s |
disk_write_iops | 硬盘写 IOPS | 块存储在统计周期内写 IOPS 的平均值 | 每秒从内存写到块存储中的 IO 次数 | 次数 | 10s、60s、300s |
disk_write_traffic | 硬盘写流量 | 块存储在统计周期内写吞吐量的平均值 | 数据从内存写入到块存储中的速率 | MB/s | 10s、60s、300s |
disk_await | 硬盘 IO 等待时间 | 块存储在统计周期内 ioawait 的平均值 | 在采样周期内有百分之几的时间 CPU 空闲并且有仍未完成的 I/O 请求 | ms | 10s、60s、300s |
disk_svctm | 硬盘 IO 服务时间 | 块存储在统计周期内 svctm 的平均值 | IO 服务时间 | ms | 10s、60s、300s |
disk_util | 硬盘 IO 繁忙比率 | 块存储在统计周期内 io_util 的平均值 | 硬盘有 IO 操作的时间(即非空间时间)的比率 | % | 10s、60s、300s |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
metricName | String | 监控指标 |
startTime | Datetime | 数据点起始时间 |
endTime | Datetime | 数据点结束时间 |
period | Int | 数据统计周期 |
dataPoints | Array | 监控数据列表 |
requestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 requestId |
4. 错误码列表
错误代码 | 描述 |
---|---|
InternalError | 内部错误 |
InvalidParameter | 参数错误(包括参数格式、类型等错误) |
5. 示例
场景描述
拉取某块云硬盘某段时间内统计周期为5分钟的读 IOPS 监控数据。
请求参数
https://monitor.api.qcloud.com/v2/index.php? &公共请求参数 &namespace=qce/block_storage &metricName=disk_read_iops &dimensions.0.name=diskId &dimensions.0.value=disk-aaaaaaaa &startTime=2018-04-16 20:00:00 &endTime=2018-04-16 20:05:00
返回参数
{
"code": 0,
"message": "",
"metricName": "disk_read_iops",
"startTime": "2018-04-16 20:00:00",
"endTime": "2018-04-16 20:05:00",
"period": 300,
"dataPoints": [
5.6,
6.7
]
}