接口描述
域名:monitor.api.qcloud.com
接口:GetMonitorData
私有网络的专线流量入口,可以通过接入多个专线通道与多个不同的 IDC 互联。
查询专线网关产品监控数据,入参取值如下:
namespace:qce/dcg
dimensions.0.name=directConnectGatewayId
dimensions.0.value 为专线网关 ID
输入参数
输入参数
参数名称 | 必选 | 类型 | 输入内容 | 描述 |
namespace | 是 | String | qce/cvm | 命名空间,每个云产品会有一个命名空间,具体名称见输入内容一栏 |
metricName | 是 | String | 具体的指标名称 | |
dimensions.0.name | 是 | String | directConnectGatewayId | 入参为专线网关 ID |
dimensions.0.value | 是 | String | 具体的专线网关 ID | 输入具体 directConnectGatewayId |
period | 否 | Int | 60/300 | |
startTime | 否 | Datetime | 起始时间 | 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的"00:00:00" |
endTime | 否 | Datetime | 结束时间 | 结束时间,默认为当前时间。endTime 不能小于 startTime |
指标名称
指标名称 | 含义 | 单位 | 维度 |
outbandwidth | 外网出带宽 | Mbps | directConnectGatewayId |
inbandwidth | 外网入带宽 | Mbps | directConnectGatewayId |
outpkg | 出包量 | 个/秒 | directConnectGatewayId |
inpkg | 入包量 | 个/秒 | directConnectGatewayId |
输出参数
参数名称 | 类型 | 描述 |
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/dcg&metricName=inpkg&dimensions.0.name=directConnectGatewayId&dimensions.0.value=dcg-4d545d&startTime=2016-06-28 14:10:00&endTime=2016-06-28 14:20:00
输出
{"code": 0,"message": "","metricName": "inpkg","startTime": "2016-06-28 14:10:00","endTime": "2016-06-28 14:20:00","period": 60,"dataPoints": [30,35,40]}