租户端 龙舟运维 云监控 API 各产品监控接口 私有网络 VPN通道

VPN通道

最近更新时间: 2019-11-22 21:01:15

1.接口描述

域名：需要确定

接口：GetMonitorData

VPN网关和对端网关建立后，即可建立VPN通道，用于私有网络和外部 IDC 之间的加密通信。

查询VPN通道产品监控数据，入参取值如下：

namespace：qce/vpnx 维度名称取值：vpnConnId dimensions.0.name=vpnConnId dimensions.0.value为VPN通道ID

2.输入参数

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

2.1输入参数

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

2.2 指标名称

指标名称 含义 单位 维度
outbandwidth 外网出带宽 Mbps vpnConnId
inbandwidth 外网入带宽 Mbps vpnConnId
outpkg 出包量 个/秒 vpnConnId
inpkg 入包量 个/秒 vpnConnId
pkgdrop 丢包率 百分比 vpnConnId
delay 时延 秒 vpnConnId

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/vpnx
&metricName=inpkg
&dimensions.0.name=vpnConnId
&dimensions.0.value=vpnx-q7v069tf
&startTime=2016-06-28 14:10:00
&endTime=2016-06-28 14:20:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "inpkg",
    "startTime": "2016-06-28 14:10:00",
    "endTime": "2016-06-28 14:20:00",
    "period": 60,
    "dataPoints": [
30,
35，
40
    ]
}