查询网关流量监控明细

最近更新时间:2024-06-25 01:26:37

我的收藏

1. 接口描述

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

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeGatewayFlowMonitorDetail。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
TimePoint Timestamp 时间点。表示要查询这分钟内的明细。如:2019-02-28 18:15:20,将查询 18:15 这一分钟内的明细。
示例值:2019-02-28 18:15:20
VpnId String VPN网关实例ID,形如:vpn-ltjahce6
示例值:vpn-ltjahce6
DirectConnectGatewayId String 专线网关实例ID,形如:dcg-ltjahce6
示例值:dcg-ltjahce6
PeeringConnectionId String 对等连接实例ID,形如:pcx-ltjahce6
示例值:pcx-ltjahce6
NatId String NAT网关实例ID,形如:nat-ltjahce6
示例值:nat-ltjahce6
Offset Integer 偏移量,默认为0。
示例值:0
Limit Integer 返回数量,默认为20,最大值为100。
示例值:20
OrderField String 排序字段。支持 InPkg OutPkg InTraffic OutTraffic,标准型nat额外支持 并发连接数ConcurrentConnectionCount 、新建连接速率NewConnectionRate。默认值OutTraffic
示例值:InPkg
OrderDirection String 排序方法。顺序:ASC,倒序:DESC。默认值DESC
示例值:ASC
PrivateIpAddress String VPC内部IPv4地址,精确匹配
示例值:10.0.1.2

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的对象数。
示例值:1
GatewayFlowMonitorDetailSet Array of GatewayFlowMonitorDetail 网关流量监控明细。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

查询一个传统型NAT网关流量监控明细

输入示例

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

输出示例

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

示例2 查询一个标准型NAT网关流量监控明细

查询一个标准型NAT网关流量监控明细

输入示例

https://vpc.tencentcloudapi.com/?Action=DescribeGatewayFlowMonitorDetail
&TimePoint=2024-06-24 14:03:00
&NatId=nat-g0pwqefo
&OrderField=InTraffic
&OrderDirection=DESC
&<公共请求参数>

输出示例

{
    "Response": {
        "GatewayFlowMonitorDetailSet": [
            {
                "PrivateIpAddress": "2.2.2.2",
                "InPkg": 5455,
                "OutPkg": 4444,
                "InTraffic": 1048576,
                "OutTraffic": 1234567,
                "NewConnectionRate": 8888,
                "ConcurrentConnectionCount": 9999
            }
        ],
        "TotalCount": 1,
        "RequestId": "396e6170-f2ce-4233-9405-9a2e5ce8b0b5"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.ModuleError 内部模块错误。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.Range 参数值不在指定范围。
UnsupportedOperation 操作不支持。