All Products
Search

This Product

    Anti-DDoS:DescribePortFlowList

    Document Center

    Anti-DDoS:DescribePortFlowList

    Last Updated:Nov 05, 2025

    Queries the traffic data list of an Anti-DDoS Proxy instance.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-ddoscoo:DescribePortFlowList

    get

    *All Resource

    *

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    ResourceGroupId

    string

    No

    The resource group ID of the Anti-DDoS Proxy instance in Resource Management. The default value is empty, which indicates that the instance belongs to the default resource group.

    For more information about resource groups, see Create a resource group.

    rg-acfm2pz25js****

    EndTime

    integer

    Yes

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

    Note

    You must set this parameter to a time that is accurate to the minute.

    1583683200

    StartTime

    integer

    Yes

    The start time of the query. This value is a UNIX timestamp in seconds.

    Note

    You must set this parameter to a time that is accurate to the minute.

    1582992000

    Interval

    integer

    Yes

    The step size of the returned data, in seconds. This parameter specifies the interval at which a result is returned. The valid values of the step size vary based on the query time range (specified by StartTime and EndTime). The following step sizes are recommended:

    • If the query time range is less than or equal to 1 hour, we recommend that you set the step size to a minimum of 60 seconds. The maximum step size cannot exceed the query time range.

    • If the query time range is greater than 1 hour but less than or equal to 6 hours, we recommend that you set the step size to a minimum of 600 seconds. The maximum step size cannot exceed the query time range.

    • If the query time range is greater than 6 hours but less than or equal to 24 hours, we recommend that you set the step size to a minimum of 1800 seconds. The maximum step size cannot exceed the query time range.

    • If the query time range is greater than 24 hours but less than or equal to 7 days, we recommend that you set the step size to a minimum of 3600 seconds. The maximum step size cannot exceed the query time range.

    • If the query time range is greater than 7 days but less than or equal to 15 days, we recommend that you set the step size to a minimum of 14400 seconds. The maximum step size cannot exceed the query time range.

    • If the query time range is greater than 15 days, we recommend that you set the step size to a minimum of 43200 seconds. The maximum step size cannot exceed the query time range.

    1000

    InstanceIds

    array

    Yes

    The ID of the Anti-DDoS instance.

    ddoscoo-cn-mp91j1ao****

    string

    No

    The ID of the Anti-DDoS Proxy instance.

    Note

    You can call DescribeInstanceIds to query the IDs of all Anti-DDoS Proxy instances.

    ddoscoo-cn-zz120cjv****

    Response elements

    Parameter

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    FFC77501-BDF8-4BC8-9BF5-B295FBC3189B

    PortFlowList

    array<object>

    The traffic data that is queried.

    object

    Index

    integer

    The index number of the returned data.

    0

    Time

    integer

    The time when the statistics were collected. This value is a UNIX timestamp in seconds.

    1582992000

    InPps

    integer

    The inbound packet forwarding rate, in packets per second (pps).

    2934

    InBps

    integer

    The inbound bandwidth, in bits per second (bps).

    2176000

    Region

    string

    The source location of the traffic. Valid values:

    • cn: the Chinese mainland.

    • alb-ap-northeast-1-gf-x: Japan.

    • alb-ap-southeast-gf-x: Singapore.

    • alb-cn-hongkong-gf-x: Hong Kong (China).

    • alb-eu-central-1-gf-x: Germany.

    • alb-us-west-1-gf-x: US (West).

    Note

    Values other than cn are available only for Anti-DDoS Proxy (Outside Chinese Mainland) (RegionId is ap-southeast-1).

    cn

    OutPps

    integer

    The outbound packet forwarding rate, in pps.

    5

    AttackPps

    integer

    The attack packet forwarding rate, in pps.

    0

    OutBps

    integer

    The outbound bandwidth, in bps.

    4389

    AttackBps

    integer

    The attack bandwidth, in bps.

    0

    SlaBpsDropBps

    integer

    The destination bandwidth, in bps.

    SlaPpsDropBps

    integer

    The destination message, in bps.

    SlaCpsDropBps

    integer

    The destination new connections, in bps.

    SlaConnDropBps

    integer

    The destination concurrent connections, in bps.

    SlaBpsDropPps

    integer

    The destination bandwidth packet forwarding rate, in pps.

    SlaPpsDropPps

    integer

    The destination message packet forwarding rate, in pps.

    SlaCpsDropPps

    integer

    The destination new connections packet forwarding rate, in pps.

    SlaConnDropPps

    integer

    The destination concurrent connections packet forwarding rate, in pps.

    Examples

    Success response

    JSON format

    {
  "RequestId": "FFC77501-BDF8-4BC8-9BF5-B295FBC3189B",
  "PortFlowList": [
    {
      "Index": 0,
      "Time": 1582992000,
      "InPps": 2934,
      "InBps": 2176000,
      "Region": "cn",
      "OutPps": 5,
      "AttackPps": 0,
      "OutBps": 4389,
      "AttackBps": 0,
      "SlaBpsDropBps": 0,
      "SlaPpsDropBps": 0,
      "SlaCpsDropBps": 0,
      "SlaConnDropBps": 0,
      "SlaBpsDropPps": 0,
      "SlaPpsDropPps": 0,
      "SlaCpsDropPps": 0,
      "SlaConnDropPps": 0
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.