接口描述
域名:monitor.api.qcloud.com
接口:GetMonitorData
查询黑石弹性公网 IP(EIP)监控数据,入参取值如下:
namespace:qce/bm_lb
dimensions.0.name=vip
dimensions.0.value为要查询的 EIP 的地址信息
英文 | 中文含义 |
vip |
输入参数
输入参数
参数名称 | 必选 | 类型 | 输入内容 | 描述 |
namespace | 是 | String | qce/bm_lb | 命名空间,每个云产品会有一个命名空间,具体名称见输入内容一栏。 |
metricName | 是 | String | 具体的指标名称 | |
dimensions.0.name | 是 | String | vip | 入参为要查询的 EIP 的地址信息 |
dimensions.0.value | 是 | String | 具体要查询的 EIP 的地址信息 | 输入具体 vip |
period | 否 | Int | 60/300 | |
startTime | 否 | Datetime | 起始时间 | 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的"00:00:00" |
endTime | 否 | Datetime | 结束时间 | 结束时间,默认为当前时间。endTime 不能小于 startTime |
指标名称
说明:
当前黑石弹性公网 IP 监控维度的取值周期为300秒(period 参数),暂不支持更细粒度的数据获取。
指标名称 | 含义 | 单位 | 纬度 |
eip_outtraffic | 外网出带宽 | Mbps | vip |
eip_intraffic | 外网入带宽 | Mbps | vip |
eip_outpkg | 外网出包量 | 个/秒 | vip |
eip_inpkg | 外网入包量 | 个/秒 | vip |
输出参数
参数名称 | 类型 | 描述 |
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/bm_lb&metricName=eip_outpkg&dimensions.0.name=vip&dimensions.0.value=115.115.115.115&startTime=2016-06-28 14:10:00&endTime=2016-06-28 14:20:00&period=300
输出
{"code": 0,"message": "","metricName": "eip_outpkg","startTime": "2016-06-28 14:10:00","endTime": "2016-06-28 14:20:00","period": 300,"dataPoints": [30,35,40]}