All Products
Search

This Product

    Cloud Firewall:DescribeNetworkTrafficTopRatio

    Document Center

    Cloud Firewall:DescribeNetworkTrafficTopRatio

    Last Updated:Dec 30, 2025

    Queries the ratio of the top network traffic.

    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 of the visitor.

    60.12.220.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
    SourceCode

    string

    Yes

    The source identifier.

    yundun
    AppName

    string

    No

    The application name.

    HTTP
    AssetIP

    string

    No

    The IP address of the asset.

    192.0.XX.XX
    AssetRegion

    string

    No

    The region where the asset resides.

    cn-beijing
    DataType

    string

    Yes

    The data type.

    Valid values:

    • in_src_location :

      Source Location

    • in_src_ip :

      source IP address

    in_src_ip
    Direction

    string

    No

    The traffic direction.

    Valid values:

    • in :

      inbound

    • out :

      outbound

    in
    DstIP

    string

    No

    The destination IP address.

    39.144.124.XXX
    DstPort

    string

    No

    The destination port.

    8080
    EndTime

    string

    Yes

    The end of the time range to query. The value is a UNIX timestamp in seconds.

    1757433863
    IpProperty

    string

    No

    The IP address property.

    proxy
    Isp

    string

    No

    The Internet Service Provider (ISP).

    电信
    Location

    string

    No

    The area.

    杭州市
    RuleResult

    string

    No

    The action triggered by the rule.

    Valid values:

    • 1 :

      alert

    • 2 :

      drop

    1
    Sort

    string

    No

    The sorting method.

    Valid values:

    • in_bytes :

      in_bytes

    • total_bytes :

      total_bytes

    in_bytes
    SrcIP

    string

    No

    The source IP address.

    172.16.169.XXX
    StartTime

    string

    Yes

    The beginning of the time range to query. The value is a UNIX timestamp in seconds.

    1749176793

    Response elements

    Element

    Type

    Description

    Example

    object

    DataType

    string

    The data type.

    Valid values:

    • in_src_location :

      Source Location

    • in_src_ip :

      source IP address

    in_src_ip
    RequestId

    string

    The request ID.

    C05D58A1-28A9-563A-BB59-5F7D1867****
    DataCount

    integer

    The number of results returned.

    1
    DataList

    array<object>

    The list of data values.

    object

    The list of data values.

    DataValue

    string

    The ratio.

    12
    DataName

    string

    The data name.

    test

    Examples

    Success response

    JSON format

    {
  "DataType": "in_src_ip",
  "RequestId": "C05D58A1-28A9-563A-BB59-5F7D1867****",
  "DataCount": 1,
  "DataList": [
    {
      "DataValue": "12",
      "DataName": "test"
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ErrorAliUid Aliuid invalid. The aliuid is invalid.
    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 ErrorTimeError The time is invalid. The time is invalid.
    400 ErrorSortError The sort is invalid. The sort is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.