DescribeDDoSBpsList - Edge Security Acceleration - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query DCDN DDoS user bps and pps data

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
esa:DescribeDDoSBpsList	get	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time for fetching data, in ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.	2023-05-14T17:00:00Z
EndTime	string	No	The end time for fetching data. In ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ. The end time must be later than the start time, and the span between start and end times should not exceed 31 days.	2023-05-18T06:19:42Z
SiteId	long	Yes	Site ID, which can be obtained by calling the ListSites API.	70966210986912
Coverage	string	No	Protection area, defaulting to global if not filled. When specified, the values are as follows: domestic: Mainland China. overseas: Global (excluding Mainland China). global: Global.	global

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	156A6B-677B1A-4297B7-9187B7-2B44792
DataInterval	integer	The interval between each piece of data, in seconds. Generated based on the interval between StartTime and EndTime: less than 1 hour, 60s; 1 hour or more but less than 1 day, 300s; 1 day or more but less than a week, 1800s; 1 week or more, 3600s.	300
StartTime	string	The start time for fetching data. In ISO8601 format, using UTC, formatted as: YYYY-MM-DDThh:mm:ssZ.	2023-05-14T17:00:00Z
EndTime	string	The end time for fetching data. In ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ. The end time must be later than the start time, and the span between start and end times should not exceed 31 days.	2023-05-18T06:19:42Z
DataModule	array<object>	A list of network bandwidth data for each time interval.
DdosBps	object	Network bandwidth data for each time interval.
TotalBps	long	Total bandwidth, in bps.	10000000000
AttackBps	long	Attack bandwidth, in bps.	9000000000
NormalBps	long	Normal business bandwidth, in bps.	1000000000
TotalPps	long	Total PPS.	100000000
AttackPps	long	Attack PPS.	9000000
NormalPps	long	Normal business PPS.	1000000
TimeStamp	string	The timestamp of this data, in ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.	2023-05-14T17:00:00Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "156A6B-677B1A-4297B7-9187B7-2B44792",
  "DataInterval": 300,
  "StartTime": "2023-05-14T17:00:00Z\n",
  "EndTime": "2023-05-18T06:19:42Z\n",
  "DataModule": [
    {
      "TotalBps": 10000000000,
      "AttackBps": 9000000000,
      "NormalBps": 1000000000,
      "TotalPps": 100000000,
      "AttackPps": 9000000,
      "NormalPps": 1000000,
      "TimeStamp": "2023-05-14T17:00:00Z"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
500	InternalError	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

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