Queries the details about the DDoS attack events that occur on an asset. The asset can be an elastic IP address (EIP). The asset can also be an Elastic Compute Service (ECS) instance or Server Load Balancer (SLB) instance that is assigned a public IP address.

Usage notes

You can call the DescribeDdosEventList operation to query the details about the DDoS attack events that occur on an asset by page. The details include the start time, end time, and status of each DDoS attack 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 DescribeDdosEventList

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

DdosRegionId String Yes cn-hangzhou

The region ID of the asset to query.

Note You can call the DescribeRegions operation to query the most recent region list.
InstanceType String Yes ecs

The type of the asset to query. Valid values:

  • ecs: ECS instance
  • slb: SLB instance
  • eip: EIP
InstanceId String Yes i-bp10bclrt56fblts****

The ID of the asset.

Note You can call the DescribeInstance operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.
CurrentPage Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10.

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 Integer 2

The total number of DDoS attack events.

RequestId String 5740363B-BCB8-5E9E-8209-6B657341B457

The ID of the request.

DdosEventList Array of DdosEvent

The list of DDoS attack events.

DdosEvent
DdosType String blackhole

The type of the DDoS attack event. Valid values:

  • defense: an attack event that triggers traffic scrubbing
  • blackhole: an attack event that triggers blackhole filtering
EndTime Long 1637817679000

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

StartTime Long 1637812279000

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

DelayTime Long 1637817679000

The time of the last attack. This value is a UNIX timestamp. Unit: milliseconds.

Note This parameter is returned only when the asset is attacked multiple times within a DDoS attack event.
DdosStatus String normal

The status of the DDoS attack event. Valid values:

  • mitigating: indicates that traffic scrubbing is in progress.
  • blackholed: indicates that blackhole filtering is triggered for the asset.
  • normal: indicates that the DDoS attack event ends.
UnBlackholeTime Long 1637814079000

The time when blackhole filtering is deactivated. This value is a UNIX timestamp. Unit: milliseconds.

Note This parameter is returned only when the value of the DdosType parameter is blackhole.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDdosEventList
&DdosRegionId=cn-hangzhou
&InstanceType=ecs
&InstanceId=i-bp10bclrt56fblts****
&CurrentPage=1
&PageSize=10
&Common request parameters

Sample success responses

XML format

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

<DescribeDdosEventListResponse>
    <DdosEventList>
        <DdosEvent>
            <EndTime>1637817679000</EndTime>
            <StartTime>1637812279000</StartTime>
            <DdosStatus>normal</DdosStatus>
            <UnBlackholeTime>1637814079000</UnBlackholeTime>
            <DdosType>blackhole</DdosType>
        </DdosEvent>
        <DdosEvent>
            <EndTime>1637812580000</EndTime>
            <StartTime>1637812173000</StartTime>
            <DdosStatus>normal</DdosStatus>
            <DdosType>defense</DdosType>
        </DdosEvent>
    </DdosEventList>
    <RequestId>5740363B-BCB8-5E9E-8209-6B657341B457</RequestId>
    <Total>2</Total>
</DescribeDdosEventListResponse>

JSON format

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

{
  "DdosEventList" : {
    "DdosEvent" : [ {
      "EndTime" : 1637817679000,
      "StartTime" : 1637812279000,
      "DdosStatus" : "normal",
      "UnBlackholeTime" : 1637814079000,
      "DdosType" : "blackhole"
    }, {
      "EndTime" : 1637812580000,
      "StartTime" : 1637812173000,
      "DdosStatus" : "normal",
      "DdosType" : "defense"
    } ]
  },
  "RequestId" : "5740363B-BCB8-5E9E-8209-6B657341B457",
  "Total" : 2
}

Error codes

For a list of error codes, visit the API Error Center.