Domain name for API request: teo.tencentcloudapi.com.
This API is used to create a cache purging task.
A maximum of 20 requests can be initiated per second for this API.
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: CreatePurgeTask. |
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. |
ZoneId | Yes | String | ID of the site |
Type | Yes | String | Type of the purging task. Values: - purge_url : Purge by the URL- purge_prefix : Purge by the prefix- purge_host : Purge by the Hostname- purge_all : Purge all cached contents |
Targets.N | No | Array of String | Target resource to be purged, which depends on the Type field.1. When Type = purge_host :Hostnames are purged, such as www.example.com and foo.bar.example.com. 2. When Type = purge_prefix :Prefixes are purged, such as http://www.example.com/example. 3. When Type = purge_url :URLs are purged, such as https://www.example.com/example.jpg. 4. When Type = purge_all : All types of resources are purged.Targets is not a required field. |
EncodeUrl | No | Boolean | Specifies whether to transcode non-ASCII URLs according to RFC3986. Note that if it’s enabled, the purging is based on the converted URLs. |
Parameter Name | Type | Description |
---|---|---|
JobId | String | Task ID |
FailedList | Array of FailReason | List of failed tasks and reasons Note: This field may return null , indicating that no valid value can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePurgeTask
<Common request parameters>
{
"Targets": [
"http://www.qq.com/a.txt",
"www.qq.com/1.txt"
],
"Type": "purge_url",
"ZoneId": "abc",
"EncodeUrl": true
}
{
"Response": {
"JobId": "20ga521cpwch",
"FailedList": [],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePurgeTask
<Common request parameters>
{
"Type": "purge_all",
"ZoneId": "abc",
"EncodeUrl": true
}
{
"Response": {
"JobId": "20ga521cpwch",
"FailedList": [],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.BackendError | Server error. |
InternalError.DomainConfig | Failed to get configuration |
InternalError.QuotaSystem | Server error. |
InvalidParameter.DomainNotFound | The domain name does not exist or is not belong to this account. |
InvalidParameter.ParameterError | Parameter error. |
InvalidParameter.Target | Resource error |
InvalidParameter.TaskNotGenerated | Failed to create the task |
InvalidParameter.UploadUrl | Invalid file upload link. |
LimitExceeded.BatchQuota | Reached the upper limit of resource number |
LimitExceeded.DailyQuota | Reached the daily upper limit of resource number |
OperationDenied | Operation denied. |
UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
本页内容是否解决了您的问题?