DescribeDdosEvent - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the details about the DDoS attack events that occurred on a specific Anti-DDoS Origin instance.

Operation description

You can call the DescribeDdosEvent operation to query the details about the DDoS attack events that occurred on a specific Anti-DDoS Origin instance by page. The details include the start time, end time, attacked IP address, and status of each event.

Limits

You can call this operation up to 10 times 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:DescribeDdosEvent	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTime	integer	Yes	The start time of the DDoS attack event to query. This value is a UNIX timestamp. Unit: seconds.	1633017600
EndTime	integer	Yes	The end time of the DDoS attack event to query. This value is a UNIX timestamp. Unit: seconds.	1638288000
PageSize	integer	Yes	The number of entries to return on each page.	10
PageNo	integer	Yes	The number of the page to return.	1
InstanceId	string	Yes	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.	ddosbgp-cn-n6w1r7nz****
Ip	string	No	The attacked IP address to query.	47.89.XX.XX
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
Total	long	The total number of DDoS attack events.	1
RequestId	string	The ID of the request.	F3B6C3F9-6B21-519D-B976-A1E14166F909
Events	object []	The details about the DDoS attack event.
EndTime	integer	The time when the DDoS attack stopped. This value is a UNIX timestamp. Unit: seconds.	1637554335
Status	string	The status of the DDoS attack event. Valid values: hole_begin: indicates that blackhole filtering is triggered for the attacked IP address. hole_end: indicates that blackhole filtering is deactivated for the attacked IP address. defense_begin: indicates that attack traffic is being scrubbed. defense_end: indicates that attack traffic is scrubbed.	defense_end
StartTime	integer	The time when the DDoS attack started. This value is a UNIX timestamp. Unit: seconds.	1637554034
Mbps	integer	The volume of the request traffic at the start of the DDoS attack. Unit: Mbit/s.	0
Ip	string	The attacked IP address.	47.89.XX.XX
Pps	integer	The number of packets at the start of the DDoS attack. Unit: packets per second (PPS).	456

Examples

Sample success responses

JSONformat

{
  "Total": 1,
  "RequestId": "F3B6C3F9-6B21-519D-B976-A1E14166F909",
  "Events": [
    {
      "EndTime": 1637554335,
      "Status": "defense_end",
      "StartTime": 1637554034,
      "Mbps": 0,
      "Ip": "47.89.XX.XX",
      "Pps": 456
    }
  ]
}

Error codes

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