tencent cloud

文档反馈

DescribeDDoSBlockList

最后更新时间:2022-11-28 16:50:42
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to query the list of DDoS blocking 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: DescribeDDoSBlockList.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
StartTime Yes Timestamp ISO8601 The start time of the attack event.
EventIds.N Yes Array of String The list of attack events.
ZoneIds.N No Array of String Specifies sites by ID. All sites will be selected if this field is not specified.
PolicyIds.N No Array of Integer The list of policy IDs to be specified. All policies will be selected if this field is not specified.
Limit No Integer Limit on paginated queries. Default value: 20. Maximum value: 1000.
Offset No Integer The page offset. Default value: 0.
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 DDoSBlockData The blocking time of a DDoS attack.
    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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of DDoS blocking data

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeDDoSBlockList
    <Common request parameters>
    
    {
        "Limit": 10,
        "Offset": 0,
        "PolicyIds": [
            1705
        ],
        "EventIds": [
            "1231412451"
        ],
        "ZoneIds": [
            "zone-21xfqlh4qjee"
        ],
        "StartTime": "2020-09-22T00:00:00+00:00",
        "Area": "overseas"
    }
    

    Output Example

    {
        "Response": {
            "TotalCount": 1,
            "RequestId": "a79e60f8-34cc-4ee5-a7f9-a24adb572c68",
            "Data": [
                {
                    "EndTime": 1660010400,
                    "StartTime": 1660010700
                }
            ]
        }
    }
    

    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.