私有网络查询nat网关流控明细

1. 接口描述

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

本接口（DescribeNatGatewayFlowMonitorDetail）用于查询NAT网关流量监控明细。

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

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeNatGatewayFlowMonitorDetail。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
TimePoint	是	Timestamp ISO8601	时间点。表示要查询的时刻。聚合粒度为60、300时，会查询最近一个整分钟开始的聚合周期；聚合粒度为3600时，会查询最近一个整点开始的聚合周期；聚合粒度为86400时，会查询最近一个整天开始的聚合周期。形如：`2019-03-24T10:51:23+08:00`。示例值：2019-03-24T10:51:23+08:00
NatGatewayId	是	String	NAT网关的ID，形如：`nat-ig8xpno8`。示例值：nat-ig8xpno8
TopN	否	Integer	展示排序靠前的数据。默认值：10，表示默认展示排序前 10 的数据。最大值：100。示例值：10
OrderField	否	String	排序字段。支持：入包量`InPkg`、出包量`OutPkg`、入流量`InTraffic`、出流量`OutTraffic`，标准型nat额外支持并发连接数`ConcurrentConnectionCount` 、新建连接速率`NewConnectionRate`。默认值`OutTraffic`。示例值：InTraffic
AggregationTimeRange	否	Integer	聚合时间粒度。支持：60、300、3600、86400，即按照1分钟、5分钟、1小时、1天进行聚合查询。示例值：60
AllMetricMode	否	Boolean	是否查询全部指标。默认值：True，表示查询全部指标。示例值：True

3. 输出参数

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

4. 示例

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

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

输入示例

https://vpc.tencentcloudapi.com/?Action=DescribeNatGatewayFlowMonitorDetail
&TimePoint=2021-12-10T09:02:01+08:00
&NatGatewayId=nat-lz6rjk7n
&OrderField=OutTraffic
&<公共请求参数>

输出示例

{
    "Response": {
        "NatGatewayFlowMonitorDetailSet": [
            {
                "OutTraffic": 15925824,
                "PrivateIpAddress": "2.2.2.188",
                "InPkg": 71466,
                "OutPkg": 57276,
                "InTraffic": 13526553,
                "ConcurrentConnectionCount": 999,
                "NewConnectionRate": 888
            }
        ],
        "TotalCount": 1,
        "RequestId": "d9b0cd80-3b86-4e03-8fc9-bc7de311bc73"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

查询nat网关流控明细

本页目录：