专线通道监控接口

最近更新时间:2019-03-21 11:26:48

1. 接口描述

域名:monitor.api.qcloud.com
接口:GetMonitorData

专线通道是物理专线的网络链路划分。

查询专项通道监控数据,入参取值如下:
namespace: qce/dcx
dimensions.0.name=directConnectConnId
dimensions.0.value为专线通道ID

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的Action字段为GetMonitorData。

2.1输入参数

参数名称 必选 类型 输入内容 描述
namespace String qce/dcx 命名空间,每个云产品会有一个命名空间,具体名称见输入内容一栏
metricName String 具体的指标名称 指标名称,具体名称见2.2
dimensions.0.name String directConnectConnId 入参为专线通道ID
dimensions.0.value String 专线通道的具体ID 调用 DescribeInstances 接口获取的unInstanceId字段
period Int 60 监控统计周期
startTime Datetime 起始时间 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的”00:00:00”
endTime Datetime 结束时间 结束时间,默认为当前时间, endTime 不能小于 startTime

2.2 指标名称

指标名称(metricName) 含义 单位 统计粒度(period)
delay 延时 ms 60s
inbandwidth 入带宽 bps 60s
inpkg 入包量 个/s 60s
outpkg 出包量 个/s 60s
outbandwidth 出带宽 bps 60s
pkgdrop 丢包 % 60s

3. 输出参数

参数名称 类型 描述
code Int 错误码, 0: 成功, 其他值表示失败
message String 返回信息
startTime Datetime 起始时间
endTime Datetime 结束时间
metricName String 指标名称
period Int 监控统计周期
dataPoints Array 监控数据列表

4. 错误码表

错误代码 错误描述 英文描述
-502 资源不存在 OperationDenied.SourceNotExists
-503 请求参数有误 InvalidParameter
-505 参数缺失 InvalidParameter.MissingParameter
-507 超出限制 OperationDenied.ExceedLimit
-509 错误的维度组合 InvalidParameter.DimensionGroupError
-513 DB操作失败 InternalError.DBoperationFail

5. 示例

输入

https://monitor.api.qcloud.com/v2/index.php?
&公共请求参数
&namespace=qce/dcx
&metricName=delay
&dimensions.0.name=directConnectConnId
&dimensions.0.value=dcx-081qsbc7
&startTime=2016-06-28 14:10:00
&endTime=2016-06-28 14:20:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "delay",
    "startTime": "2016-06-28 14:10:00",
    "endTime": "2016-06-28 14:20:00",
    "period": 300,
    "dataPoints": [
        5.6,
        6.5,
        7.7
    ]
}