DescribeDDoSEvents - Anti-DDoS - Alibaba Cloud Documentation Center

Queries attack events on Anti-DDoS Pro or Anti-DDoS Premium instances.

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

yundun-ddoscoo:DescribeDDoSEvents

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group in Resource Management to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs. By default, this parameter is empty, which means that the instance belongs to the default resource group.	default
EndTime	integer	No	The end of the time range to query. This is a UNIX timestamp. Unit: seconds. Note The timestamp must be on the minute.	1583683200
StartTime	integer	Yes	The beginning of the time range to query. This is a UNIX timestamp. Unit: seconds. Note The timestamp must be on the minute.	1582992000
PageSize	integer	Yes	The number of entries to return on each page.	10
PageNumber	integer	Yes	The number of the page to return. For example, to query the first page, set this parameter to 1.	1
InstanceIds	array	Yes	The IDs of the Anti-DDoS Pro or Anti-DDoS Premium instances. Note Call DescribeInstanceIds to query the IDs of all Anti-DDoS Pro and Anti-DDoS Premium instances.	ddoscoo-cn-mp91j1ao****
	string	No	The ID of the Anti-DDoS Pro or Anti-DDoS Premium instance.	ddoscoo-cn-mp91j1ao****

Response elements

Element	Type	Description	Example
	object
Total	integer	The total number of attack events.	1
RequestId	string	The ID of the request.	0CA72AF5-1795-4350-8C77-50A448A2F334
DDoSEvents	array<object>	A list of DDoS attack events.
	object
EndTime	integer	The time when the attack ended. This is a UNIX timestamp. Unit: seconds.	1583933330
StartTime	integer	The time when the attack started. This is a UNIX timestamp. Unit: seconds.	1583933277
EventType	string	The type of the attack event. Valid values: defense: scrubbing events. blackhole: blackhole filtering events.	blackhole
Region	string	The source location of the attack. Valid values: cn: the Chinese mainland. alb-ap-northeast-1-gf-x: Japan. alb-ap-southeast-gf-x: Singapore. alb-cn-hongkong-gf-x: Hong Kong (China). alb-eu-central-1-gf-x: Germany. alb-us-west-1-gf-x: US (West). Note Values other than cn are available only for the Anti-DDoS Premium service, for which the RegionId is ap-southeast-1.	cn
Ip	string	The attacked IP address.	203.*.*.132
Port	string	The attacked port.	80
Bps	integer	The bandwidth of the attack traffic. Unit: Mbps.	0
Pps	integer	The packet forwarding rate of the attack traffic. Unit: pps.	0

Examples

Success response

JSON format

{
  "Total": 1,
  "RequestId": "0CA72AF5-1795-4350-8C77-50A448A2F334",
  "DDoSEvents": [
    {
      "EndTime": 1583933330,
      "StartTime": 1583933277,
      "EventType": "blackhole",
      "Region": "cn",
      "Ip": "203.***.***.132",
      "Port": "80",
      "Bps": 0,
      "Pps": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.