获取VPN通道的监控数据
最近更新时间: 2024-06-12 15:06:00
1. 接口描述
本接口(DescribeVpnConnMonitor)用于获取VPN通道的监控数据。 接口请求域名：vpc.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见公共请求参数页面。其中，此接口的Action字段为DescribeVpnConnMonitor。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| vpcId | 是 | string | 私有网络ID，可使用vpcId或unVpcId，建议使用unVpcId，例如：vpc-03vihbk9,可通过 DescribeVpcEx 接口查询。 |
| vpnGwId | 是 | String | 系统分配的VPN网关ID，可使用vpnGwId或unVpnGwId，建议unVpnGwId，例如：vpngw-dystbrkv。可通过 DescribeVpnGw 接口查询。 |
| vpnConnId | 是 | String | 系统分配的VPN通道ID，可使用vpnConnId或unVpnConnId，建议使用unVpnConnId，例如：vpnx-ol6bcqp0。可通过 DescribeVpnConn 接口查询。 |
| metricName | 是 | String | 监控指标名称（目前只支持两个指标：“outtraffic”公网出流量；"intraffic" 公网入流量） |
| starttime | 否 | datetime | 开始时间，开始时间不填写默认为昨天此时。时间跨度不能超过2天。超过2天时，开始时间将被设置为结束时间减2天，例如：2016-07-06 12:00:00 |
| endtime | 否 | datetime | 结束时间，结束时间不填写默认是当前时间，例如：2016-07-07 12:00:00 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Int | 错误码，0：成功，其他值：失败 |
| message | String | 错误信息 |
| data.data | Array | 通道指标流量带宽，单位bps，每5min记录。 示例：data[1] 表示 (starttime+5) ~ (starttime+10) min的通道指标流量带宽，metricName为outtraffic表示返回出流量，intraffic时表示返回为入流量 |
4. 错误码表
该接口没有业务错误码，公共错误码详见公共错误码。
5. 示例
输入
https://domain/v2/index.php?Action=DescribeVpnConnMonitor &<公共请求参数> &vpcId=7 &vpnGwId=8 &vpnConnId=5 &metricName=outtraffic &starttime=2015-07-14 00:00:00 &endtime=2015-07-14 23:00:00
输出
{
"code" : 0,
"message" : "ok",
"data" : [
1221,
1212,
787
],
}