tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribePurgeTasks

最后更新时间：2023-03-09 17:41:55

1. API Description

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

This API is used to query the cache purging history.

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-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
JobId No String Task ID
Type No String Type of the purging task
StartTime No Timestamp ISO8601 Start time of the query
EndTime No Timestamp ISO8601 End time of the query
Offset No Integer Offset of the query
Limit No Integer Maximum number of results returned
Statuses.N No Array of String Statuses of tasks to be queried. Values:
processing, success, failed, timeout and invalid
ZoneId No String ID of the site
Domains.N No Array of String List of domain names queried
Target No String Queries content

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the cache purging history

Input Example

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

{
    "ZoneId": "abc",
    "StartTime": "2022-02-09T00:00:00+08:00",
    "EndTime": "2022-02-09T23:59:00+08:00",
    "Statuses": [
        "success"
    ],
    "Limit": 1,
    "Offset": 7,
    "Domains": [
        "www.qq.com"
    ]
}

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

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 Internal error.
InvalidParameter.ParameterError Parameter error.
OperationDenied Operation denied.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款