DescribeGatewayFlowMonitorDetail

Last updated: 2020-03-06 20:26:41

1. API Description

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

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

  • Only querying of a single gateway instance is supported. That is, only one of the VpnId, DirectConnectGatewayId, PeeringConnectionId, or NatId input parameters is supported, and one must be used.
  • 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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeGatewayFlowMonitorDetail.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the traffic monitoring details of a NAT gateway

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeGatewayFlowMonitorDetail
&TimePoint=2019-02-28 18:15:20
&NatId=nat-lz6rjk7n
&Limit=5
&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"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.