tencent cloud

All product documents
APIs
DocumentationAPIsVirtual Private CloudGateway Traffic Monitor APIsDescribeGatewayFlowMonitorDetail
DescribeGatewayFlowMonitorDetail
Last updated: 2025-03-11 22:34:46
DescribeGatewayFlowMonitorDetail
Last updated: 2025-03-11 22:34:46

1. API Description

Domain name for API request: vpc.intl.tencentcloudapi.com.

This API is used to query the traffic monitoring details of the gateway.

  • You can only use this API to query a single gateway instance, which means you must pass in only one of VpnId, DirectConnectGatewayId, PeeringConnectionId, or NatId.
  • If the gateway has traffic, but no data is returned when this API is called, please check whether gateway traffic monitoring has been enabled in the corresponding gateway details page in the console.

A maximum of 30 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeGatewayFlowMonitorDetail.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TimePoint Yes Timestamp The point in time. This indicates details of this minute will be queried. For example, in 2019-02-28 18:15:20, details at 18:15 will be queried.
VpnId No String The instance ID of the VPN gateway, such as vpn-ltjahce6.
DirectConnectGatewayId No String The instance ID of the Direct Connect gateway, such as dcg-ltjahce6.
PeeringConnectionId No String The instance ID of the peering connection, such as pcx-ltjahce6.
NatId No String The instance ID of the NAT gateway, such as nat-ltjahce6.
Offset No Integer Offset.
Limit No Integer The returned quantity.
OrderField No String The order field supports InPkg, OutPkg, InTraffic, and OutTraffic.
OrderDirection No String Order methods. Ascending: ASC, Descending: DESC.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The number of objects meeting the condition.
GatewayFlowMonitorDetailSet Array of GatewayFlowMonitorDetail The gateway traffic monitoring details.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the Traffic Monitoring Details of a Traditional NAT Gateway

This example shows you how to query the traffic monitoring details of a traditional NAT gateway.

Input Example

https://vpc.intl.tencentcloudapi.com/?Action=DescribeGatewayFlowMonitorDetail
&TimePoint=2019-02-28 18:15:20
&NatId=nat-lz6rjk7n
&OrderField=OutTraffic
&OrderDirection=DESC
&<common request parameters>

Output Example

{
    "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"
    }
}

Example2 Querying the Traffic Monitoring Details of a Standard NAT Gateway

This example shows you how to query the traffic monitoring details of a standard NAT gateway.

Input Example

https://vpc.intl.tencentcloudapi.com/?Action=DescribeGatewayFlowMonitorDetail
&TimePoint=2024-06-24 14:03:00
&NatId=nat-g0pwqefo
&OrderField=InTraffic
&OrderDirection=DESC
&<common request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.ModuleError Internal module error
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.Range The parameter value is not in the specified range.
UnsupportedOperation Unsupported operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon