DescribeDDoSAttackEvent

Last updated: 2025-10-30 22:02:50

DescribeDDoSAttackEvent

Last updated: 2025-10-30 22:02:50

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to query DDoS attack events.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeDDoSAttackEvent.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
StartTime	Yes	Timestamp ISO8601	The start time.
EndTime	Yes	Timestamp ISO8601	End time. the query time range (`EndTime` - `StartTime`) must be less than or equal to 31 days.
PolicyIds.N	No	Array of Integer	List of DDoS policy IDs. All policies are selected if this field is not specified.
ZoneIds.N	No	Array of String	Site ID set. The parameter will change from optional to mandatory after May 30, 2024.Refer to Cloud API Change Notification. A maximum of 100 site ids can be imported. use `*` to query data for all sites under the tencent cloud root account. to query account-level data, you must have resource permissions for all sites in this api.
Limit	No	Integer	Limit on paginated queries. Default value: 20. Maximum value: 1000.
Offset	No	Integer	The page offset. Default value: 0.
ShowDetail	No	Boolean	Parameter to show attack details. If it is configured as false, only the number of attacks is returned without details. If it is configured as true, attack details are returned.
Area	No	String	Geolocation scope. Values: `overseas`: Regions outside the Chinese mainland `mainland`: Chinese mainland `global`: Global If this field is not specified, the default value `global` is used.
OrderBy	No	String	The sorting field. Values: `MaxBandWidth`: Peak bandwidth `AttackStartTime` Start time of the attack If this field is not specified, the default value `AttackStartTime` is used.
OrderType	No	String	The sorting method. Values: `asc`: Ascending `desc`: Descending If this field is not specified, the default value `desc` is used.

3. Output Parameters

Parameter Name	Type	Description
Data	Array of DDoSAttackEvent	List of DDoS attack data. Note: This field may return `null`, indicating that no valid value was found.
TotalCount	Integer	Total number of query results.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying a DDoS attack event

Querying a DDoS attack event

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDDoSAttackEvent
<Common request parameters>{
    "Limit": 1,
    "Offset": 1,
    "PolicyIds": [
        1245
    ],
    "ZoneIds": [
        "zone-21xfqlh4qjee"
    ],
    "StartTime": "2020-09-22T00:00:00+00:00",
    "EndTime": "2020-09-22T00:00:00+00:00",
    "ShowDetail": false,
    "Area": "overseas"
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "Data": [
            {
                "EventId": "12214521",
                "AttackPacketMaxRate": 10,
                "AttackEndTime": 1659595468,
                "AttackMaxBandWidth": 10,
                "AttackStartTime": 1659595468,
                "ZoneId": "zone-21xfqlh4qjee",
                "PolicyId": 1245,
                "AttackType": "UDPFLOOD",
                "AttackStatus": 1,
                "Area": "mainland",
                "DDoSBlockData": [
                    {
                        "StartTime": 1659595468,
                        "EndTime": 0,
                        "BlockArea": "Access resitricted in some regions."
                    }
                ]
            }
        ],
        "RequestId": "c0ce8b7c-a48f-4eed-a0eb-c24177efc430"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation failed.
InternalError.ProxyServer	An unknown error occurred in the backend server.
LimitExceeded	The quota limit has been reached.
LimitExceeded.QueryTimeLimitExceeded	Query time limit exceeded.
OperationDenied	Operation denied.
ResourceNotFound	The resource doesn’t exist.
UnauthorizedOperation.CamUnauthorized	CAM is not authorized.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud