All Products
Search

This Product

    Cloud Firewall:DescribeInternetTrafficTop

    Document Center

    Cloud Firewall:DescribeInternetTrafficTop

    Last Updated:Jan 07, 2026

    Queries the top Internet traffic trends.

    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
    SourceIp

    string

    No

    The source IP address.

    117.82.14.XXX
    Lang

    string

    No

    The language of the response.

    Valid values:

    • en :

      English

    • zh :

      Chinese

    zh
    Lang

    string

    No

    The language of the response.

    Valid values:

    • en :

      English

    • zh :

      Chinese

    zh
    Direction

    string

    No

    The traffic direction.

    Valid values:

    • in :

      Inbound traffic

    • out :

      Outbound traffic

    in
    StartTime

    string

    Yes

    The start time. The value is a UNIX timestamp. Unit: seconds.

    1656664560
    EndTime

    string

    Yes

    The end time. The value is a UNIX timestamp. Unit: seconds.

    1734055824
    SourceCode

    string

    Yes

    The tracing code for the source.

    yundun
    DataType

    string

    Yes

    The type of traffic data.

    Valid values:

    • in_src_location :

      Source location

    • in_src_ip :

      Source IP address

    in_src_ip
    RuleResult

    string

    No

    The action of the rule.

    Valid values:

    • 0 :

      Allow

    • 1 :

      Alert

    • 2 :

      Drop

    1
    RuleSource

    string

    No

    The source of the rule.

    Valid values:

    • 1 :

      Basic protection

    • 2 :

      Virtual patching

    • 3 :

      Basic ACL

    • 4 :

      Threat intelligence

    1
    Sort

    string

    No

    The sorting method.

    Valid values:

    • in_bytes :

      in_bytes

    • session_count :

      session_count

    • out_bytes :

      out_bytes

    • total_bytes :

      total_bytes

    • out_packets :

      out_packets

    • in_packets :

      in_packets

    in_bytes
    ShowCountryName

    string

    No

    The name of the country to display.

    China
    Limit

    string

    No

    The maximum number of top entries to return. The default value is 50. Valid values: 1 to 50.

    50

    Response elements

    Element

    Type

    Description

    Example

    object

    DataType

    string

    The type of traffic data.

    Valid values:

    • in_src_location :

      Source location

    • in_src_ip :

      Source IP address

    in_src_ip
    RequestId

    string

    The ID of the request.

    15FCCC52-1E23-57AE-B5EF-3E00A3******
    DataCount

    integer

    The number of traffic data entries.

    10
    DataList

    array<object>

    The list of traffic data.

    object

    The list of traffic data.

    DataValue

    string

    The inbound traffic percentage.

    47.12
    SessionCount

    integer

    The number of sessions.

    27
    TotalBytes

    integer

    The total traffic. Unit: bytes.

    0
    DataName

    string

    The name of the country.

    US
    IsSubscribed

    boolean

    Indicates whether the data is subscribed.

    false
    LabelList

    array

    The list of labels.

    string

    A label.

    NA

    Examples

    Success response

    JSON format

    {
  "DataType": "in_src_ip",
  "RequestId": "15FCCC52-1E23-57AE-B5EF-3E00A3******",
  "DataCount": 10,
  "DataList": [
    {
      "DataValue": "47.12",
      "SessionCount": 27,
      "TotalBytes": 0,
      "DataName": "US",
      "IsSubscribed": false,
      "LabelList": [
        "NA"
      ]
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorSourceCodeError The source code is invalid. The source code is invalid.
    400 ErrorDataTypeError The data type is invalid. The data type is invalid.
    400 ErrorDirectionError The direction is invalid. The direction is invalid.
    400 ErrorRuleSourceError The rule source is invalid. The rule source is invalid.
    400 ErrorTimeError The time is invalid. The time is invalid.
    400 ErrorIntervalError The interval is invalid. The interval is invalid.
    400 ErrorSortError The sort is invalid. The sort is invalid.
    400 ErrorLimitCountFailed The limit count is invalid. The limit is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.