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

Usage notes

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDdosEvent

The operation that you want to perform. Set the value to DescribeDdosEvent

StartTime Integer Yes 1633017600

The start time of the DDoS attack event to query. This value is a UNIX timestamp. Unit: seconds.

EndTime Integer Yes 1638288000

The end time of the DDoS attack event to query. This value is a UNIX timestamp. Unit: seconds.

PageSize Integer Yes 10

The number of entries to return on each page.

PageNo Integer Yes 1

The number of the page to return.

InstanceId String Yes ddosbgp-cn-n6w1r7nz****

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.
Ip String No 47.89.XX.XX

The attacked IP address to query.

ResourceGroupId String No rg-acfm2pz25js****

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.

RegionId String No cn-hangzhou

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.

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 Example Description
Total Long 1

The total number of DDoS attack events.

RequestId String F3B6C3F9-6B21-519D-B976-A1E14166F909

The ID of the request.

Events Array of Event

The details about the DDoS attack event.

EndTime Integer 1637554335

The time when the DDoS attack stopped. This value is a UNIX timestamp. Unit: seconds.

Status String defense_end

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.
StartTime Integer 1637554034

The time when the DDoS attack started. This value is a UNIX timestamp. Unit: seconds.

Mbps Integer 0

The volume of the request traffic at the start of the DDoS attack. Unit: Mbit/s.

Ip String 47.89.XX.XX

The attacked IP address.

Pps Integer 456

The number of packets at the start of the DDoS attack. Unit: packets per second (PPS).

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDdosEvent
&StartTime=1633017600
&EndTime=1638288000
&PageSize=10
&PageNo=1
&InstanceId=ddosbgp-cn-n6w1r7nz****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDdosEventResponse>
    <Total>1</Total>
    <RequestId>F3B6C3F9-6B21-519D-B976-A1E14166F909</RequestId>
    <Events>
        <EndTime>1637554335</EndTime>
        <Status>defense_end</Status>
        <StartTime>1637554034</StartTime>
        <Mbps>0</Mbps>
        <Ip>47.89.XX.XX</Ip>
        <Pps>456</Pps>
    </Events>
</DescribeDdosEventResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 API Error Center.