tencent cloud



Last updated: 2022-02-23 10:16:37

1. API Description

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

This API is used to query the submission record and progress of purge tasks.


If you have migrated your ECDN service to CDN, you can use the corresponding CDN API.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribePurgeTasks.
Version Yes String Common parameter. The value used for this API: 2019-10-12.
Region No String Common parameter. This parameter is not required for this API.
PurgeType No String Purge type to be queried. url: query URL purge records; path: query directory purge records.
StartTime No Timestamp Start time, such as 2018-08-08 00:00:00
EndTime No Timestamp End time, such as 2018-08-08 23:59:59
TaskId No String Task ID returned during submission. Either TaskId or start time must be specified for a query.
Offset No Integer Pagination offset. Default value: 0 (starting from entry 0).
Limit No Integer Pagination limit. Default value: 20.
Keyword No String Query keyword. Please enter a domain name or full URL beginning with http(s)://.
Status No String Specified task status to be queried. fail: failed, done: succeeded, process: purging.

3. Output Parameters

Parameter Name Type Description
PurgeLogs Array of PurgeTask Purge history.
TotalCount Integer Total number of tasks, which is used for pagination.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the purge history

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "4d5a83f8-a61f-445b-8036-5636be640bef",
    "PurgeLogs": [
        "TaskId": "153303185323131331",
        "Url": "http://www.test.com/",
        "Status": "Done",
        "PurgeType": "url",
        "FlushType": "flush",
        "CreateTime": "2018-07-30 18:10:53"
    "TotalCount": 20

5. Developer Resources


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
InternalError.EcdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.EcdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.EcdnParamError Parameter error. Please see the sample parameters in the documentation.
ResourceNotFound.EcdnDomainNotExists This domain name does not exist under the account. Please check and try again.
ResourceNotFound.EcdnUserNotExists The ECDN service has not been activated. Please activate it first before using this API.
UnauthorizedOperation.EcdnCamUnauthorized No CAM policy is configured for the sub-account.
UnauthorizedOperation.EcdnMigratedCdn Please go to the CDN console for operation.
UnauthorizedOperation.EcdnUserIsSuspended The acceleration service has been suspended. Please restart it and try again.
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