tencent cloud

All product documents
APIs
DocumentationAPIs Anti-DDoSStatistical Report APIsDescribeOverviewDDoSEventList
DescribeOverviewDDoSEventList
Last updated: 2025-04-01 16:03:54
DescribeOverviewDDoSEventList
Last updated: 2025-04-01 16:03:54

1. API Description

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

This API is used to obtain the list of DDoS attacks.

A maximum of 20 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: DescribeOverviewDDoSEventList.
Version Yes String Common Params. The value used for this API: 2020-03-09.
Region No String Common Params. This parameter is not required for this API.
StartTime Yes String Start time
EndTime Yes String End time
AttackStatus No String Filters by the attack status. start: The attack is ongoing; end: The attack ends.
Offset No Integer The offset value
Limit No Integer Total number of records

3. Output Parameters

Parameter Name Type Description
Total Integer Total number of records
EventList Array of OverviewDDoSEvent Event list
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 Getting a list of DDoS events

Input Example

https://antiddos.intl.tencentcloudapi.com/?Action=DescribeOverviewDDoSEventList
&StartTime=2020-02-01 12:04:12
&EndTime=2020-02-03 18:03:23
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "Total": 1,
        "EventList": [
            {
                "Id": "ddosev-00000421",
                "Vip": "10.143.145.42",
                "StartTime": "2021-04-14 14:14:54",
                "EndTime": "2021-04-14 14:16:23",
                "AttackType": "SYNFLOOD",
                "AttackStatus": 0,
                "Mbps": 23414,
                "Pps": 2313,
                "Business": "bgpip",
                "InstanceId": "bgpip-00000143",
                "InstanceName": "test"
            }
        ]
    }
}

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

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
AuthFailure CAM signature/authentication error.
DryRunOperation The DryRun operation means that the request will be successful, but an extra DryRun parameter is passed.
FailedOperation Operation failed.
InternalError Internal error. Please try again later.
InvalidParameter Parameter error.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit should not be exceeded.
MissingParameter Missing parameters. Please check and try again.
OperationDenied Operation denied.
RequestLimitExceeded The number of requests should not exceed the frequency limit.
ResourceInUse The resource is occupied.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist. Please try again later.
ResourceUnavailable The resource is unavailable.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation The operation is unauthorized.
UnknownParameter Unknown parameter error. Please check and try again.
UnsupportedOperation Unsupported operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support