Tencent Cloud

DescribeDDosAttackData

Last updated: 2023-03-09 17:41:54

1. API Description

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

This API is used to query the DDoS attack data.

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: DescribeDDosAttackData.
Version	Yes	String	Common Params. The value used for this API: 2022-01-06.
Region	No	String	Common Params. This parameter is not required for this API.
StartTime	Yes	Timestamp ISO8601	Start time
EndTime	Yes	Timestamp ISO8601	End time
MetricNames.N	Yes	Array of String	List of statistical metrics
ZoneIds.N	No	Array of String	List of site IDs
PolicyIds.N	No	Array of Integer	List of DDoS policy group IDs
Port	No	Integer	Port number
ProtocolType	No	String	Protocol type. Valid values: tcp, udp, all
AttackType	No	String	Attack type. Valid values: flood, icmpFlood..., all
Interval	No	String	Query time granularity. Valid values: {min,5min,hour,day}

3. Output Parameters

Parameter Name	Type	Description
Data	Array of SecEntry	DDoS attack data Note: This field may return null, indicating that no valid values can be obtained.
Status	Integer	Status. 1: failed; 0: succeeded
Msg	String	Returned data
Interval	String	Query time granularity. Valid values: {min,5min,hour,day}
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying DDoS attack logs

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDDosAttackData
<Common request parameters>

{
    "AttackType": "xx",
    "MetricNames": [
        "xx"
    ],
    "ProtocolType": "xx",
    "Interval": "xx",
    "PolicyIds": [
        0
    ],
    "ZoneIds": [
        "xx"
    ],
    "StartTime": "2020-09-22T00:00:00+00:00",
    "EndTime": "2020-09-22T00:00:00+00:00",
    "Port": 0
}

Output Example

{
    "Response": {
        "Status": 0,
        "Msg": "xx",
        "Interval": "xx",
        "Data": [
            {
                "Value": [
                    {
                        "Max": 0,
                        "Metric": "xx",
                        "Avg": 0.0,
                        "Detail": [
                            {
                                "Value": 0
                            }
                        ],
                        "Sum": 0.0
                    }
                ],
                "Key": "xx"
            }
        ],
        "RequestId": "xx"
    }
}

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
LimitExceeded	The quota limit has been reached.
UnauthorizedOperation.CamUnauthorized	CAM is not authorized.

tencent cloud

Recent Pages

DescribeDDosAttackData

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying DDoS attack logs

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeDDosAttackData

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying DDoS attack logs

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?