tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud EdgeOne
    Documentation
    Download PDF

    DescribeDDoSAttackTopData

    Last updated: 2024-04-09 10:26:09
    Download PDF

      1. API Description

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

      This API is used to query the top-ranked DDoS attack data.

      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: DescribeDDoSAttackTopData.
      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 The end time.
      MetricName Yes String The statistical metric. Values:
    • ddos_attackFlux_protocol: Rank protocols by the attack traffic.
    • ddos_attackPackageNum_protocol: Rank protocols by the number of attack packets.
    • ddos_attackNum_attackType: Rank attack types by the number of attacks.
    • ddos_attackNum_sregion: Rank attacker regions by the number of attacks.
    • ddos_attackFlux_sip: Rank attacker IPs by the number of attacks.
    • ddos_attackFlux_sregion: Rank attacker regions by the number of attacks.
      		•
      ZoneIds.N No Array of String Site ID set. This parameter is required.
      PolicyIds.N No Array of Integer The list of DDoS policy IDs to be specified. All policies will be selected if this field is not specified.
      AttackType No String The attack type. Values:
    • flood: Flood;
    • icmpFlood: ICMP flood;
    • all: All attack types.
      • This field will be set to the default value all if not specified.
      ProtocolType No String The protocol type. Values:
    • tcp: TCP protocol;
    • udp: UDP protocol;
    • all: All protocol types.
      • This field will be set to the default value all if not specified.
      Port No Integer The port number.
      Limit No Integer Queries the top n rows of data. Top 10 rows of data will be queried if this field is not specified.
      Area No String Data storage region. Values:
    • overseas: Global (outside the Chinese mainland);
    • mainland: Chinese mainland.
      • If this field is not specified, the data storage region will be determined based on the user’s location.

      3. Output Parameters

      Parameter Name Type Description
      Data Array of TopEntry The list of top-ranked DDoS attack data.
      Note: This field may return null, indicating that no valid values can be obtained.
      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 the top-ranked DDoS attack data

      Input Example

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

{
    "AttackType": "UDPFLOOD",
    "MetricName": "ddos_attackFlux_protocol",
    "ProtocolType": "udp",
    "PolicyIds": [
        1705
    ],
    "ZoneIds": [
        "zone-21xfqlh4qjee"
    ],
    "Limit": 1,
    "StartTime": "2020-09-22T00:00:00+00:00",
    "EndTime": "2020-09-22T00:00:00+00:00",
    "Port": 22,
    "Area": "overseas"
}

      Output Example

      {
    "Response": {
        "TotalCount": 10,
        "Data": [
            {
                "Value": [
                    {
                        "Count": 123,
                        "Name": "udp"
                    }
                ],
                "Key": "zone-21xfqlh4qjee"
            }
        ],
        "RequestId": "3824cf60-c2aa-4f4a-95b7-a4d5e4dee188"
    }
}

      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
      FailedOperation Operation failed.
      InternalError.ProxyServer An unknown error occurred in the backend server.
      LimitExceeded.QueryTimeLimitExceeded Query time limit exceeded.
      ResourceNotFound The resource doesn’t exist.
      UnauthorizedOperation.CamUnauthorized CAM is not authorized.
      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
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy