DescribePortFlowList - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the traffic data of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribePortFlowList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	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.	rg-acfm2pz25js****
EndTime	long	Yes	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that is accurate to the minute.	1583683200
StartTime	long	Yes	The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. This UNIX timestamp must indicate a point in time that is accurate to the minute.	1582992000
Interval	integer	Yes	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.	1000
InstanceIds	array	Yes	An array that consists of the IDs of instances.
	string	Yes	The ID of the instance. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-zz120cjv****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	FFC77501-BDF8-4BC8-9BF5-B295FBC3189B
PortFlowList	array<object>	The returned traffic data.
PortFlow	object
Index	long	The index number of the returned data.	0
Time	long	The time when the data was collected. The value is a UNIX timestamp. Unit: seconds.	1582992000
InPps	long	The packet forwarding rate of inbound traffic. Unit: packets per second.	2934
InBps	long	The inbound bandwidth. Unit: bit/s.	2176000
Region	string	The source region of the traffic. Valid values: cn: mainland China alb-ap-northeast-1-gf-x: Japan (Tokyo) alb-ap-southeast-gf-x: Singapore alb-cn-hongkong-gf-x: Hong Kong (China) alb-eu-central-1-gf-x: Germany (Frankfurt) alb-us-west-1-gf-x: US (Silicon Valley) Note The values except cn are returned only when RegionId is set to ap-southeast-1.	cn
OutPps	long	The packet forwarding rate of outbound traffic. Unit: packets per second (pps).	5
AttackPps	long	The packet forwarding rate of attack traffic. Unit: pps.	0
OutBps	long	The outbound bandwidth. Unit: bit/s.	4389
AttackBps	long	The bandwidth of attack traffic. Unit: bit/s.	0

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-05-24	The response structure of the API has changed	View Change Details
2023-04-18	The response structure of the API has changed	View Change Details