DescribeTraffic - Anti-DDoS - Alibaba Cloud Documentation Center

Queries traffic statistics of an Anti-DDoS Origin instance within a specific time period.

Operation description

You can call the DescribeTraffic operation to query traffic statistics of an Anti-DDoS Origin instance within a specific time period.

Note When you call this operation, you must configure the InstanceId parameter to specify the Anti-DDoS Origin instance whose traffic statistics you want to query.

Limits

You can call this operation once per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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-antiddosbag:DescribeTraffic	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the Anti-DDoS Origin instance to query. Note You can call the DescribeInstanceList operation to query the IDs of all Anti-DDoS Origin instances. If you specify an on-demand instance, you must configure the Interval parameter.	ddosbgp-cn-n6w203qg****
Ipnet	string	No	The Classless Inter-Domain Routing (CIDR) block of the on-demand instance that you want to query.	111.XX.XX.0/24
Ip	string	No	The public IP address of the asset to query. If you do not specify this parameter, the traffic statistics of all public IP addresses that are protected by the Anti-DDoS Origin instance are queried. Note The public IP address must be a protected object of the Anti-DDoS Origin instance. You can call the DescribePackIpList operation to query all protected objects of the Anti-DDoS Origin instance.	39.XX.XX.96
StartTime	integer	Yes	The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.	1619798400
EndTime	integer	No	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the current system time is used as the end time.	1563445054
Interval	integer	No	The interval at which the traffic statistics are calculated. Unit: seconds. Default value: 5.	5
FlowType	string	No	The type of the traffic statistics to query. Valid values: max: the peak traffic within the specified interval avg: the average traffic within the specified interval Enumeration Value: all avg max	max
ResourceGroupId	string	No	The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management. If you do not specify this parameter, the instance belongs to the default resource group.	rg-acfm2pz25js****
RegionId	string	No	The ID of the region where the Anti-DDoS Origin instance resides. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

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	Description	Example
	object
RequestId	string	The ID of the request.	6A507DC8-F657-4C13-84E2-D1D1B9400753
FlowList	object []	The queried traffic statistics.
Time	integer	The time when the traffic statistics are calculated. This value is a UNIX timestamp. Unit: seconds.	1620951900
FlowType	string	The type of the traffic statistics. Valid values: max: the peak traffic within the specified interval avg: the average traffic within the specified interval	max
AttackPps	long	The packet forwarding rate of attack traffic. Unit: packets per second. Note This parameter is returned only if attack traffic exists.	0
Name	string	The ID of the traffic statistics.	8e33f19e-5644-11eb-b5c1-d89d67182200
Pps	integer	The packet forwarding rate of the total traffic. Unit: packets per second.	274
Kbps	integer	The bandwidth of the total traffic. Unit: Kbit/s.	417
AttackBps	long	The bandwidth of attack traffic. Unit: bit/s. Note This parameter is returned only if attack traffic exists.	0

Examples

Sample success responses

JSONformat

{
  "RequestId": "6A507DC8-F657-4C13-84E2-D1D1B9400753",
  "FlowList": [
    {
      "Time": 1620951900,
      "FlowType": "max",
      "AttackPps": 0,
      "Name": "8e33f19e-5644-11eb-b5c1-d89d67182200",
      "Pps": 274,
      "Kbps": 417,
      "AttackBps": 0
    }
  ]
}

Error codes

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