tencent cloud

APIs

DocumentaçãoAPIs Anti-DDoSBlackhole Unblocking APIsDescribeDDoSBlockRecords

DescribeDDoSBlockRecords

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-07-08 10:48:29

1. API Description

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

Query block unblock records and unblocking quota info.

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: DescribeDDoSBlockRecords.
Version Yes String Common Params. The value used for this API: 2025-09-03.
Region No String Common Params. This parameter is not required for this API.
StartTime Yes Timestamp ISO8601

Start time of the query. Support up to data query for the past one year.

Parameter format: 2026-02-04T11:30:00+08:00.
EndTime Yes Timestamp ISO8601

End time of query. The query time range (EndTime - StartTime) must be less than or equal to 31 days.

Parameter format: 2026-03-04T11:30:00+08:00.
Filters.N No Array of Filter

Filter criteria. The maximum number of Filters.Values is 20. If this parameter is left empty, return the current list of resources blocked under the appid. Detailed filter criteria:

  • Resource: Filter by blocked IP or six-segment resource format;
  • Status: Filter by blocked resource status.

When Filters.Name value is Status, Filters.Values valid values:

  • Blocked: blocked;
  • Unblocking: unblocking;
  • Unblocked: unblocked.
Limit No Integer

Paginated query limit count. Maximum value: 100.

Default value: 20
Offset No Integer

Paginated query offset.

Default value: 0.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Total number of block and unblock records.
BlockRecords Array of DDoSBlockRecord

Unblock record.
UnblockQuotaInfo DDoSUnblockQuota

Quota information of the number of unblocking times.
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 block list by public IP address

Query the block/unblock list.

Input Example

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

{
    "StartTime": "2026-04-05T11:30:00+08:00",
    "EndTime": "2026-04-21T11:15:00+08:00",
    "Filters": [
        {
            "Name": "Resource",
            "Values": [
                "43.136.33.201"
            ]
        }
    ],
    "Limit": 1,
    "Offset": 0
}

Output Example

{
    "Response": {
        "BlockRecords": [
            {
                "BlockTime": "2026-04-21T10:53:00+08:00",
                "Resource": "43.136.33.201",
                "Status": "Blocked"
            }
        ],
        "TotalCount": 4,
        "UnblockQuotaInfo": {
            "QuotaEndTime": "2026-04-22T00:00:00+08:00",
            "QuotaStartTime": "2026-04-21T00:00:00+08:00",
            "TotalQuota": 3,
            "UsedQuota": 3
        },
        "RequestId": "b450f3fd-6f30-4e2d-84d6-35e5c0afd25d"
    }
}

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.

Anterior: UnblockResourcesPróximo: DescribeIpBlockList

Ajuda e Suporte

Esta página foi útil?

comentários