1. 接口描述
域名:monitor.api.qcloud.com
接口:GetMonitorData
腾讯云全球应用加速(Global Application Accelerate Platform)是基于全球节点之间的高速通道、转发集群及智能路由技术而打造的一款网络加速产品。
qce/qaap是全球应用加速对应的命名空间,您可以在此空间查询到全球应用加速的所有监控数据
查询全球应用加速-监听器源站维度监控数据,入参值如下:
namespace:qce/qaap
dimensions.0.name=channelId
dimensions.0.value 为通道 ID
dimensions.1.name=listenerId
dimensions.1.value 为监听器 ID
dimensions.2.name=originServerInfo
dimensions.2.value 为源站的 IP 地址或者域名
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 |
dimensions.1.name | listenerId | 监听器 ID | String类型维度名称:listenerId |
dimensions.1.value | listenerId | 监听器 ID | 具体监听器 ID,如 listener-1234abcd |
dimensions.2.name | originServerInfo | 源站信息 | String 类型维度名称:originServerInfo |
dimensions.2.value | originServerInfo | 源站信息 | 源站的 IP 或者域名,如 www.test.com |
2.2指标名称
指标名称(metricName) | 含义 | 单位 |
---|---|---|
listener_rs_status | 该监听器下源站的健康状态(0为异常,1为正常) | 无 |
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=listener_rs_status &dimensions.0.name=channelId &dimensions.0.value=link-abcd1234 &dimensions.1.name=listenerId &dimensions.1.value=listener-1234abcd &dimensions.2.name=originServerInfo &dimensions.2.value=111.111.11.11 &startTime=2017-12-12 14:10:00 &endTime=2017-12-12 14:20:00
输出
{
"code": 0,
"message": "",
"metricName": "listener_rs_status",
"startTime": "2016-06-28 14:10:00",
"endTime": "2016-06-28 14:20:00",
"period": 300,
"dataPoints": [
1,
0,
1
]
}