接口描述
域名:monitor.api.qcloud.com
接口:GetMonitorData
共享带宽包(BWP)是 一种多 IP 聚合的计费模式 ,可大幅降低公网费用。
查询带宽包产品监控数据,入参取值如下:
namespace:qce/bwp
维度名称取值:bandwidthPackageId
dimensions.0.name=bandwidthPackageId
dimensions.0.value 为带宽包的唯一 ID
输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详细请参见 公共请求参数 文档。其中,此接口的 Action 字段为 GetMonitorData。
输入参数
参数名称 | 必选 | 类型 | 输入内容 | 描述 |
---|---|---|---|---|
namespace | 是 | String | qce/bwp | 命名空间,每个云产品会有一个命名空间,具体名称见输入内容一栏 |
metricName | 是 | String | 具体的指标名称 | 指标名称,详细请见本文 指标名称 列表 |
dimensions.0.name | 是 | String | bandwidthPackageId | 入参为带宽包的 ID |
dimensions.0.value | 是 | String | 具体的带宽包的 ID | 调用 DescribeBandwidthPackages 接口获取的 BandwidthPackageId 字段 |
period | 否 | Int | 60/300 | 监控统计周期,绝大部分指标支持60s统计粒度,部分指标仅支持300s统计粒度,统计粒度根据指标的不同而变,输入参数时可参考 指标名称 列表 |
startTime | 否 | Datetime | 起始时间 | 起始时间,如"2016-01-01 10:25:00",默认时间为当天的”00:00:00” |
endTime | 否 | Datetime | 结束时间 | 结束时间,默认为当前时间, endTime 不能小于 startTime |
指标名称
指标名称 | 含义 | 单位 | 维度 |
---|---|---|---|
outtraffic | 外网出带宽 | Mbps | bandwidthPackageId |
intraffic | 外网入带宽 | Mbps | bandwidthPackageId |
outpkg | 出包量 | 个/秒 | bandwidthPackageId |
inpkg | 入包量 | 个/秒 | bandwidthPackageId |
输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码,0:成功,其他值表示失败 |
message | String | 返回信息 |
startTime | Datetime | 起始时间 |
endTime | Datetime | 结束时间 |
metricName | String | 指标名称 |
period | Int | 监控统计周期 |
dataPoints | Array | 监控数据列表 |
错误码
错误代码 | 错误描述 | 英文描述 |
---|---|---|
-502 | 资源不存在 | OperationDenied.SourceNotExists |
-503 | 请求参数有误 | InvalidParameter |
-505 | 参数缺失 | InvalidParameter.MissingParameter |
-507 | 超出限制 | OperationDenied.ExceedLimit |
-509 | 错误的维度组合 | InvalidParameter.DimensionGroupError |
-513 | DB操作失败 | InternalError.DBoperationFail |
示例
输入
https://monitor.api.qcloud.com/v2/index.php? &公共请求参数 &namespace=qce/bwp &metricName=intraffic &dimensions.0.name=bandwidthPackageId &dimensions.0.value=bwp-7ios0atg &startTime=2016-06-28 14:10:00 &endTime=2016-06-28 14:20:00
输出
{
"code": 0,
"message": "",
"MetricName": "intraffic",
"StartTime": "2018-04-11 15:10:00",
"EndTime": "2018-04-11 15:20:00",
"Period": 300,
"DataPoints": [
0.003,
0.003,
0.003
]
}