Query DDoS Attack Events via DescribeDDoSAllEventList - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries DDoS attack events for a specified site within a given time range.

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:DescribeDDoSAllEventList

get

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time of the query. The time must be in ISO 8601 format and in UTC. Format: `yyyy-MM-ddTHH:mm:ssZ`.	2023-02-12T15:00:00Z
EndTime	string	No	The end time of the query. The time must be in ISO 8601 format and in UTC. Format: `yyyy-MM-ddTHH:mm:ssZ`. The time range between `StartTime` and `EndTime` cannot exceed 31 days. Defaults to the current time.	2023-02-22T15:59:59Z
EventType	string	No	The type of DDoS attack events to query. Valid values: web-cc: A web resource exhaustion attack. cc: A connection-based attack. traffic: A traffic-based attack. Defaults to `web-cc`.	web-cc
PageNumber	integer	Yes	The page number to return. Valid range: 1 to 100000.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Valid values: 5, 10, and 20.	10
SiteId	integer	Yes	The site ID. Obtain this value from the ListSites operation.	7096621098****

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	D73A4243-CFBD-5110-876F-09237E77ECBD
SiteId	integer	The site ID.	7096621098****
TotalCount	integer	The total number of entries returned.	1
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
DataList	array<object>	A list of DDoS attack event details.
	object	Details of a DDoS attack event.
Target	string	The attack target.	example.com
TargetId	string	The ID of the attack target.	000000000155****
StartTime	string	The start time of the DDoS attack event. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is in UTC.	2023-02-12T15:00:00Z
EndTime	string	The end time of the DDoS attack event. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is in UTC.	2023-02-12T15:59:59Z
EventType	string	The type of the DDoS attack event. Valid values: web-cc: A web resource exhaustion attack. cc: A connection-based attack. traffic: A volumetric attack.	web-cc
Bps	integer	The peak bits per second (Bps) of a volumetric attack.	800
Pps	integer	The peak packets per second (Pps) of a volumetric attack.	12000
Cps	integer	The peak connections per second (Cps) of a connection-based attack.	50
EventId	string	The event ID.	web-cc_1
Qps	integer	The peak queries per second (Qps) of a web resource exhaustion attack.	7692
Coverage	string	The attack region. Valid values: domestic: Chinese mainland. global: Global. overseas: global (excluding Chinese mainland).	domestic
EventResult	string	The event result. Valid values: clean: The attack was successfully cleaned. ratelimit: Rate limiting was applied. blackhole: Blackhole filtering was triggered.	clean

Examples

Success response

JSON format

{
  "RequestId": "D73A4243-CFBD-5110-876F-09237E77ECBD",
  "SiteId": 0,
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "DataList": [
    {
      "Target": "example.com",
      "TargetId": "000000000155****",
      "StartTime": "2023-02-12T15:00:00Z",
      "EndTime": "2023-02-12T15:59:59Z",
      "EventType": "web-cc",
      "Bps": 800,
      "Pps": 12000,
      "Cps": 50,
      "EventId": "web-cc_1",
      "Qps": 7692,
      "Coverage": "domestic",
      "EventResult": "clean"
    }
  ]
}

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.