Queries the traffic data of an Anti-DDoS Pro or Anti-DDoS Premium instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribePortFlowList

The operation that you want to perform. Set the value to DescribePortFlowList.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance. This is the default value.
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance.
ResourceGroupId String No rg-acfm2pz25js****

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

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

EndTime Long Yes 1583683200

The end of the time range to query. Set the value to a UNIX timestamp. Unit: seconds.

Note This UNIX timestamp must indicate a point in time that is accurate to the minute.
StartTime Long Yes 1582992000

The beginning of the time range to query. Set the value to a UNIX timestamp. Unit: seconds.

Note This UNIX timestamp must indicate a point in time that is accurate to the minute.
Interval Integer Yes 1000

The interval for returning data. Unit: seconds. The interval that you can specify varies based on the time range to query. The time range to query is determined by the values of StartTime and EndTime.

  • If the time range to query is no greater than 1 hour, we recommend that you specify the interval from 60 seconds to the time range to query.
  • If the time range to query is greater than 1 hour but no greater than 6 hours, we recommend that you specify the interval from 600 seconds to the time range to query.
  • If the time range to query is greater than 6 hours but no greater than 24 hours, we recommend that you specify the interval from 1,800 seconds to the time range to query.
  • If the time range to query is greater than 24 hours but no greater than 7 days, we recommend that you specify the interval from 3,600 seconds to the time range to query.
  • If the time range to query is greater than 7 days but no greater than 15 days, we recommend that you specify the interval from 14,400 seconds to the time range to query.
  • If the time range to query is greater than 15 days, we recommend that you specify the interval from 43,200 seconds to the time range to query.
InstanceIds.N String Yes ddoscoo-cn-zz120cjv****

The ID of the instance.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String FFC77501-BDF8-4BC8-9BF5-B295FBC3189B

The ID of the request.

PortFlowList Array of PortFlow

The returned traffic data.

Index Long 0

The index number of the returned data.

Time Long 1582992000

The time when the data was collected. The value is a UNIX timestamp. Unit: seconds.

InPps Long 2934

The packet forwarding rate of inbound traffic. Unit: packets per second.

InBps Long 2176000

The inbound bandwidth. Unit: bit/s.

Region String cn

The source region of the traffic. Valid values:

  • cn: mainland China
  • 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: Western United States
Note The values except cn are returned only when RegionId is ap-southeast-1.
OutPps Long 5

The packet forwarding rate of outbound traffic. Unit: packets per second.

AttackPps Long 0

The packet forwarding rate of attack traffic. Unit: packets per second.

OutBps Long 4389

The outbound bandwidth. Unit: bit/s.

AttackBps Long 0

The bandwidth of attack traffic. Unit: bit/s.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribePortFlowList
&ResourceGroupId=rg-acfm2pz25js****
&EndTime=1583683200
&StartTime=1582992000
&Interval=1000
&InstanceIds=["ddoscoo-cn-zz120cjv****"]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePortFlowListResponse>
    <RequestId>FFC77501-BDF8-4BC8-9BF5-B295FBC3189B</RequestId>
    <PortFlowList>
        <Index>0</Index>
        <Time>1582992000</Time>
        <InPps>2934</InPps>
        <InBps>2176000</InBps>
        <Region>cn</Region>
        <OutPps>5</OutPps>
        <AttackPps>0</AttackPps>
        <OutBps>4389</OutBps>
        <AttackBps>0</AttackBps>
    </PortFlowList>
</DescribePortFlowListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.