通道负载

最近更新时间:2019-01-17 14:54:35

1. 接口描述

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

腾讯云全球应用加速(Global Application Accelerate Platform)是基于全球节点之间的高速通道、转发集群及智能路由技术而打造的一款网络加速产品。

qce/qaap是全球应用加速对应的命名空间,您可以在此空间查询到全球应用加速的所有监控数据
查询全球应用加速-通道维度监控数据,入参值如下:
namespace:qce/qaap
dimensions.0.name=channelId
dimensions.0.value 为通道 ID

2.输入参数

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

2.1 输入参数

2.1.1 输入参数总览

参数名称 必选 类型 输入内容 描述
namespace String qce/qaap 命名空间,每个云产品会有一个命名空间,具体名称见输入内容一栏。
metricName String 具体的指标名称 指标名称,具体名称见2.2
dimensions.n.name String 维度的名称 维度的名称,具体维度名称见第2.1.2小节,与 dimensions.n.value 配合使用。
dimensions.n.value String 对应的维度的值 对应的维度的值,具体维度名称见第2.1.2小节,与dimensions.n.name配合使用。
period Int 60/300 监控统计周期,绝大部分指标支持60s统计粒度,部分指标仅支持300s统计粒度,统计粒度根据指标的不同而变。输入参数时可参考2.2的指标详情列表。
startTime Datetime 起始时间 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的”00:00:00”
endTime Datetime 结束时间 结束时间,默认为当前时间。 endTime不能小于startTime

2.1.2 各维度对应参数总览

参数名称 维度名称 维度解释 格式
dimensions.0.name channelId 加速通道 ID String类型维度名称:channelId
dimensions.0.value channelId 加速通道 ID 具体通道 ID,如 link-abcd1234

2.2 指标名称

指标名称(metricName) 含义 单位
connum 并发连接数
inbandwidth 入带宽 Mbps
outbandwidth 出带宽 Mbps

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?
&公共请求参数
&namepace=qce/qaap
&metricName=inbandwidth
&dimensions.0.name=channelId
&dimensions.0.value=link-abcd1234
&startTime=2017-12-12 14:10:00
&endTime=2017-12-12 14:20:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "inbandwidth",
    "startTime": "2016-06-28 14:10:00",
    "endTime": "2016-06-28 14:20:00",
    "period": 300,
    "dataPoints": [
        1313,
        1512,
        2321
    ]
}