All Products
Search

This Product

    Cloud Firewall:DescribeNatFirewallTimeTop

    Document Center

    Cloud Firewall:DescribeNatFirewallTimeTop

    Last Updated:Nov 13, 2025

    Retrieves the top traffic data for a NAT firewall at a specified time.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Lang

    string

    No

    The language of the response.

    Valid values:

    • en :

      English

    • zh :

      Chinese

    zh
    SrcPublicIP

    string

    No

    The public IP address of the NAT Gateway.

    47.93.47.XXX
    NatGatewayId

    string

    No

    The ID of the NAT Gateway.

    ngw-uf62zzi7000bca7zn****
    SrcPrivateIP

    string

    No

    The private IP address of the NAT Gateway.

    10.100.134.XXX
    Sort

    string

    No

    The sorting method.

    Valid values:

    • total_max_bps :

      total_max_bps

    • out_max_bps :

      out_max_bps

    • in_max_bps :

      in_max_bps

    total_max_bps
    Limit

    integer

    No

    The maximum number of entries to return. Default value: 200. Valid values: 1 to 500.

    20
    TrafficTime

    string

    Yes

    The point in time to query. Use a UNIX timestamp. The timestamp is in seconds.

    1749693960
    Interval

    integer

    No

    The time interval.

    60

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    C5DDD596-1191-5F36-A504-8733045A****
    DataCount

    integer

    The number of returned entries.

    2
    TrafficTime

    string

    The point in time of the traffic data. The value is a UNIX timestamp. The timestamp is in seconds.

    1656923760
    DataList

    array<object>

    The list of data.

    object

    The list of data.

    Ip

    string

    The IP address.

    10.66.231.XXX
    InBps

    integer

    The inbound bandwidth. Unit: bps.

    187
    OutBps

    integer

    The outbound bandwidth. Unit: bps.

    45
    TotalBps

    integer

    The total bandwidth. Unit: bps.

    232
    SessionCount

    string

    The total number of sessions.

    27
    NewConn

    string

    The number of new connections.

    27
    ResourceInstanceId

    string

    The ID of the asset instance.

    i-bp130nn8h6157dir****
    ResourceInstanceName

    string

    The name of the asset instance.

    test
    RegionNo

    string

    The region.

    cn-qingdao
    NatGatewayId

    string

    The ID of the NAT Gateway.

    ngw-uf6pnry5vpawb****
    NatGatewayName

    string

    The name of the NAT Gateway.

    ngw-test
    NatFirewallId

    string

    The ID of the NAT firewall.

    vfw-tr-7a9c8901ed394****

    NatFirewallName

    string

    The name of the NAT firewall.

    vfw-test

    Examples

    Success response

    JSON format

    {
  "RequestId": "C5DDD596-1191-5F36-A504-8733045A****",
  "DataCount": 2,
  "TrafficTime": "1656923760",
  "DataList": [
    {
      "Ip": "10.66.231.XXX",
      "InBps": 187,
      "OutBps": 45,
      "TotalBps": 232,
      "SessionCount": "27",
      "NewConn": "27",
      "ResourceInstanceId": "i-bp130nn8h6157dir****",
      "ResourceInstanceName": "test",
      "RegionNo": "cn-qingdao",
      "NatGatewayId": "ngw-uf6pnry5vpawb****",
      "NatGatewayName": "ngw-test",
      "NatFirewallId": "vfw-tr-7a9c8901ed394****\n",
      "NatFirewallName": "vfw-test"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.