tencent cloud

Feedback

DescribeCCTrend

Last updated: 2023-05-24 14:57:48

1. API Description

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

This API is used to get CC attack data, including total QPS peaks, attack QPS, total number of requests and number of attack requests.

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: DescribeCCTrend.
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.
Business Yes String Anti-DDoS service type. bgpip: Anti-DDoS Advanced; bgp: Anti-DDoS Pro (Single IP); bgp-multip: Anti-DDoS Pro (Multi-IP); net: Anti-DDoS Ultimate; basic: Anti-DDoS Basic
Ip Yes String Instance IP
Period Yes Integer Sampling period. Valid values: 300 (5 minutes), 3600 (one hour), 86400 (one day)
StartTime Yes Timestamp Beginning of the time range for the query
EndTime Yes Timestamp End of the time range for the query
MetricName Yes String Metric. Valid values: inqps (total QPS peaks), dropqps (attack QPS peaks), incount (total number of requests), and dropcount (number of attack requests).
Domain No String (Optional) Domain name
Id No String Instance ID. Leave this field empty when Business is basic, as basic protection does not require an instance.

3. Output Parameters

Parameter Name Type Description
Count Integer Number of values returned
Business String Anti-DDoS service type. bgpip: Anti-DDoS Advanced; bgp: Anti-DDoS Pro (Single IP); bgp-multip: Anti-DDoS Pro (Multi-IP); net: Anti-DDoS Ultimate; basic: Anti-DDoS Basic
Ip String Instance IP
Period Integer Sampling period. Valid values: 300 (5 minutes), 3600 (one hour), 86400 (one day)
StartTime Timestamp Beginning of the time range for the query
EndTime Timestamp End of the time range for the query
Data Array of Integer Value array
Id String Instance ID
Note: this field may return null, indicating that no valid values can be obtained.
MetricName String Metric. Valid values: inqps (total QPS peaks), dropqps (attack QPS peaks), incount (total number of requests), and dropcount (number of attack requests).
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting CC attack data

Input Example

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

{
    "Domain": "www.test.com",
    "Business": "bgp",
    "Ip": "1.2.3.4",
    "Period": 0,
    "StartTime": "2020-09-22 00:00:00",
    "EndTime": "2020-09-22 00:00:00",
    "Id": "bgp-00000010",
    "MetricName": "inqps"
}

Output Example

{
    "Response": {
        "Business": "bgp",
        "Count": 1,
        "Data": [
            1234
        ],
        "EndTime": "2018-08-27 16:05:10",
        "Id": "bgp-00000010",
        "Ip": "3.3.3.3",
        "MetricName": "inqps",
        "Period": 300,
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "StartTime": "2018-08-27 15:05:10"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Contact Us

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

Technical Support

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

7x24 Phone Support