tencent cloud



Last updated: 2024-05-29 14:55:56

    1. API Description

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

    DescribePurgeTasks is used to query the submitted URL refreshing and directory refreshing records and execution progress. This interface can be used to query the tasks submitted by the CreatePurgeTasks 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.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribePurgeTasks.
    Version Yes String Common Params. The value used for this API: 2022-09-01.
    Region No String Common Params. This parameter is not required.
    ZoneId No String ZoneId. The parameter is required.
    StartTime No Timestamp ISO8601 Start time of the query. Either time or job-id is required.
    EndTime No Timestamp ISO8601 End time of the query. Either time or job-id is required.
    Offset No Integer Offset for paginated queries. Default value: 0.
    Limit No Integer Limit on paginated queries. Default value: 20. Maximum value: 1000.
    Filters.N No Array of AdvancedFilter Filtering condition. The maximum value of Filters.Values is 20. Detailed filtering conditions:
  • job-id
    Filter based on task ID. job-id format: 1379afjk91u32h. Multiple values are not supported, Fuzzy search is not supported;
  • target
    Filter based on: target resource information. target format: http://www.qq.com/1.txt or tag1. Multiple values are not supported, Fuzzy search is not supported;
  • domains
    Filter based on domain name. domains format: www.qq.com, Fuzzy search is not supported;
  • statuses
    Filter based on task status, Fuzzy search is not supported. Options:
    processing: Processing
    success: Success
    failed: Failure
    timeout: Timeout
  • type
    Filter based on cleared cache type. Multiple values are not supported, Fuzzy search is not supported. Options:
    purge_url: URL
    purge_prefix: Prefix
    purge_all: All cache content
    purge_host: Hostname
    purge_cache_tag: CacheTag
  • 3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total entries that match the specified query condition.
    Tasks Array of Task List of tasks returned.
    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 Historical Records of Cache Purging

    After the refreshing task is submitted by using CreatePurgeTasks, use this API to query the refreshing task records and execution progress.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribePurgeTasks
    <Common request parameters>
        "ZoneId": "zone-wz8m9mgx",
        "StartTime": "2022-02-09T00:00:00+08:00",
        "EndTime": "2022-02-09T23:59:00+08:00",
        "Limit": 1,
        "Offset": 7

    Output Example

        "Response": {
            "RequestId": "abc-afhhakf-24hkahf-2424",
            "Tasks": [
                    "JobId": "20g9wz8m9mgx",
                    "Status": "success",
                    "Target": "http://www.qq.com/a.txt",
                    "Type": "purge_url",
                    "CreateTime": "2022-02-09T02:28:43Z",
                    "UpdateTime": "2022-02-09T02:28:52Z"
            "TotalCount": 8

    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 Internal error.
    InvalidParameter.ParameterError Parameter error: Invalid “End time”. The interval between the start and end time cannot exceed 7 days.
    OperationDenied Operation denied.
    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