DescribeDDoSAttackData

1. API Description

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

This API is used to query the time-series data of DDoS attacks.

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: DescribeDDoSAttackData.
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	Start time of the query period.
EndTime	Yes	Timestamp ISO8601	End time of the query period.
MetricNames.N	Yes	Array of String	Statistical metrics. `ddos_attackMaxBandwidth`: Peak attack bandwidth; `ddos_attackMaxPackageRate`: Peak attack packet rate; `ddos_attackBandwidth`: Time-series data of attack bandwidth; `ddos_attackPackageRate`: Time-series data of attack packet rate.
ZoneIds.N	No	Array of String	ZoneId set. This parameter is required.
PolicyIds.N	No	Array of Integer	IDs of DDoS policies to be queried. All policies will be selected if this field is not specified.
Interval	No	String	The query granularity. Values: `min`: 1 minute; `5min`: 5 minutes; `hour`: 1 hour; `day`: 1 day If this field is not specified, the granularity is determined based on the query period. Period ≤ 1 hour: `min`; 1 hour < Period ≤ 2 days: `5min`; 2 days < Period ≤ 7 days: `hour`; Period > 7 days: `day`.
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.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of query results.
Data	Array of SecEntry	List of DDoS attack data. Note: This field may return null, indicating that no valid values can be obtained.
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 the Time-series Data of DDoS Attacks

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDDoSAttackData
<Common request parameters>
{
    "MetricNames": [
        "ddos_attackMaxBandwidth"
    ],
    "Interval": "min",
    "PolicyIds": [
        1706
    ],
    "ZoneIds": [
        "zone-21xfqlh4qjee"
    ],
    "StartTime": "2022-08-22T00:00:00+00:00",
    "EndTime": "2022-08-23T00:00:00+00:00",
    "Area": "overseas"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Data": [
            {
                "Value": [
                    {
                        "Max": 100,
                        "Metric": "ddos_attackMaxBandwidth",
                        "Avg": 100.0,
                        "Detail": [
                            {
                                "Value": 100
                            }
                        ],
                        "Sum": 100.0
                    }
                ],
                "Key": "ddos_attackMaxBandwidth"
            }
        ],
        "RequestId": "a79e60f8-34cc-4ee5-a7f9-a24adb572c68"
    }
}

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.
ResourceNotFound	The resource doesn’t exist.
UnauthorizedOperation.CamUnauthorized	CAM is not authorized.
UnauthorizedOperation.NoPermission	The sub-account is not authorized for the operation. Please get permissions first.