云联网监控接口

最近更新时间:2019-03-21 14:16:47

1. 接口描述

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

云联网(Cloud Connect Network,CCN)为您提供云上私有网络(Virtual Private Cloud,VPC)间、VPC 与本地数据中心间互联的服务。

查询云联网产品监控数据,入参取值如下:
namespace:qce/vbc

单地域/地域间维度名称取值:CcnId
dimensions.0.name=CcnId
dimensions.0.value=ccn-c889docn

地域间维度名称取值:SRegion, DRegion
dimensions.1.name=SRegion
dimensions.1.value=ap-shanghai
dimensions.2.name=DRegion
dimensions.2.value=ap-guangzhou

2. 输入参数

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

参数名称 必选 类型 描述
namespace String 命名空间,每个云产品会有一个命名空间,具体名称见下文地域间指标名称和单地域指标名称
metricName String 指标名称,具体名称见各产品监控接口中的说明文档
dimensions.n.name String 维度的名称,具体维度名称见下文地域间指标名称和单地域指标名称,各产品监控指标列表与 dimensions.n.value 配合使用
dimensions.n.value String 对应的维度的值,具体维度名称见见地域间指标名称和单地域指标名称,各产品监控指标列表与 dimensions.n.name 配合使用
period Int 监控统计周期,默认为取值为300,单位为s(秒)。目前 CVM、负载均衡、容器服务支持 60s、300s 粒度,其他产品支持仅300s,后续将逐步支持更多产品
startTime Datetime 起始时间,如 "2016-01-01 10:25:00", 默认时间为当天的 “00:00:00”
endTime Datetime 结束时间,默认为当前时间,endTime 不能小于 startTime

2.1 地域间指标名称

指标名称 含义 单位 维度
OutPkg 地域间出包量 个/秒 地域间: CcnId, SRegion, DRegion
InPkg 地域间入包量 个/秒 地域间: CcnId, SRegion, DRegion
OutBandwidth 地域间出带宽 Mbps 地域间: CcnId, SRegion, DRegion
InBandwidth 地域间入带宽 Mbps 地域间: CcnId, SRegion, DRegion

2.2 单地域指标名称

指标名称 含义 单位 维度
RegionOutPkg 单地域总出包量 个/秒 单地域: CcnId
RegionInPkg 单地域总入包量 个/秒 单地域: CcnId
RegionOutBandwidth 单地域总出带宽 Mbps 单地域: CcnId
RegionInBandwidth 单地域总入带宽 Mbsp 单地域: CcnId

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. 示例

示例1: 查询地域间监控

输入

https://monitor.api.qcloud.com/v2/index.php?
&公共请求参数
&namespace=qce/vbc
&metricName=RegionOutBandwidth
&dimensions.0.name=CcnId
&dimensions.0.value=ccn-nzdqxrvn
&dimensions.1.name=SRegion
&dimensions.1.value=ap-shanghai
&dimensions.2.name=DRegion
&dimensions.2.value=ap-guangzhou
&startTime=2018-10-30 14:10:00
&endTime=2018-10-30 14:15:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "RegionOutBandwidth",
    "startTime": "2018-10-30 14:10:00",
    "endTime": "2018-10-30 14:20:00",
    "period": 60,
    "dataPoints": [
        30,
        30,
        35,
        35,
        40
    ]
}

示例2:查询单地域的监控

输入

https://monitor.api.qcloud.com/v2/index.php?
&公共请求参数
&namespace=qce/vbc
&metricName=RegionOutBandwidth
&dimensions.0.name=CcnId
&dimensions.0.value=ccn-nzdqxrvn
&startTime=2018-10-30 14:10:00
&endTime=2018-10-30 14:15:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "RegionOutBandwidth",
    "startTime": "2018-10-30 14:10:00",
    "endTime": "2018-10-30 14:20:00",
    "period": 60,
    "dataPoints": [
        30,
        30,
        35,
        35,
        40
    ]
}