DescribeDDoSBpsList - Query DDoS network-layer BPS and PPS data - Edge Security Acceleration

Queries DDoS network-layer BPS and PPS data for a specified site.

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

esa:DescribeDDoSBpsList

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	Start time of the query range. Format: yyyy-MM-ddTHH:mm:ssZ (ISO 8601, UTC+0).	2023-05-14T17:00:00Z
EndTime	string	No	End time of the query range. Format: yyyy-MM-ddTHH:mm:ssZ (ISO 8601, UTC+0). Must be later than StartTime. Maximum span: 31 days.	2023-05-18T06:19:42Z
SiteId	integer	Yes	Site ID. Call the ListSites operation to obtain this value.	70966210986912
Coverage	string	No	Protection region. Defaults to global. Valid values: domestic: Chinese mainland. overseas: outside the Chinese mainland. global: worldwide. Valid values: domestic : domestic global : global overseas : overseas	global

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	156A6B-677B1A-4297B7-9187B7-2B44792
DataInterval	integer	Data granularity in seconds. Auto-determined by query range: under 1 hour = 60s, 1 hour to 1 day = 300s, 1 day to 1 week = 1800s, over 1 week = 3600s.	300
StartTime	string	Start time of the returned data. Format: YYYY-MM-DDThh:mm:ssZ (ISO 8601, UTC).	2023-05-14T17:00:00Z
EndTime	string	End time of the returned data. Format: yyyy-MM-ddTHH:mm:ssZ (ISO 8601, UTC+0). Must be later than StartTime. Maximum span: 31 days.	2023-05-18T06:19:42Z
DataModule	array<object>	Network bandwidth data per time interval.
	object	Bandwidth data for a single time interval.
TotalBps	integer	Total bandwidth (bps).	10000000000
AttackBps	integer	Attack bandwidth (bps).	9000000000
NormalBps	integer	Normal traffic bandwidth (bps).	1000000000
TotalPps	integer	Total PPS.	100000000
AttackPps	integer	Attack PPS.	9000000
NormalPps	integer	Normal traffic PPS.	1000000
TimeStamp	string	Timestamp of this data point. Format: yyyy-MM-ddTHH:mm:ssZ (ISO 8601, UTC+0).	2023-05-14T17:00:00Z

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.