文档中心 私有网络 API文档 其他接口 查询网关流量监控明细

查询网关流量监控明细

最近更新时间:2019-05-09 21:58:57

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeGatewayFlowMonitorDetail)用于查询网关流量监控明细。

  • 只支持单个网关实例查询。即入参 VpnId DirectConnectGatewayId PeeringConnectionId NatId 最多只支持传一个,且必须传一个。
  • 如果网关有流量,但调用本接口没有返回数据,请在控制台对应网关详情页确认是否开启网关流量监控。

默认接口请求频率限制:30次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeGatewayFlowMonitorDetail
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
TimePoint Timestamp 时间点。表示要查询这分钟内的明细。如:2019-02-28 18:15:20,将查询 18:15 这一分钟内的明细。
VpnId String VPN网关实例ID,形如:vpn-ltjahce6
DirectConnectGatewayId String 专线网关实例ID,形如:dcg-ltjahce6
PeeringConnectionId String 对等连接实例ID,形如:pcx-ltjahce6
NatId String NAT网关实例ID,形如:nat-ltjahce6
Offset Integer 偏移量。
Limit Integer 返回数量。
OrderField String 排序字段。支持 InPkg OutPkg InTraffic OutTraffic
OrderDirection String 排序方法。顺序:ASC,倒序:DESC

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的对象数。
GatewayFlowMonitorDetailSet Array of GatewayFlowMonitorDetail 网关流量监控明细。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询一个NAT网关流量监控明细

输入示例

https://vpc.tencentcloudapi.com/?Action=DescribeGatewayFlowMonitorDetail
&TimePoint=2019-02-28 18:15:20
&NatId=nat-lz6rjk7n
&Limit=5
&OrderField=OutTraffic
&OrderDirection=DESC
&<公共请求参数>

输出示例

{
  "Response": {
    "GatewayFlowMonitorDetailSet": [
      {
        "PrivateIpAddress": "172.20.65.74",
        "InPkg": 182,
        "OutPkg": 263,
        "InTraffic": 17316,
        "OutTraffic": 35269
      },
      {
        "PrivateIpAddress": "172.20.65.63",
        "InPkg": 0,
        "OutPkg": 20,
        "InTraffic": 0,
        "OutTraffic": 1960
      },
      {
        "PrivateIpAddress": "172.20.65.70",
        "InPkg": 0,
        "OutPkg": 20,
        "InTraffic": 0,
        "OutTraffic": 1960
      },
      {
        "PrivateIpAddress": "172.20.65.172",
        "InPkg": 0,
        "OutPkg": 20,
        "InTraffic": 0,
        "OutTraffic": 1960
      },
      {
        "PrivateIpAddress": "172.20.65.249",
        "InPkg": 0,
        "OutPkg": 20,
        "InTraffic": 0,
        "OutTraffic": 1960
      }
    ],
    "TotalCount": 261,
    "RequestId": "0fc9884d-7aa1-4d95-95d3-7945108d2b10"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码