DescribePurgeTasks

Last updated: 2020-07-31 11:15:02

1. API Description

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

This API is used to query the submission history of purge tasks and their execution progress.

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 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 purge history

Input Example

https://ecdn.tencentcloudapi.com/?Action=DescribePurgeTasks
&PurgeType=ur
&TaskId=1234567
&<Common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
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.EcdnUserIsSuspended The acceleration service has been suspended. Please restart it and try again.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help