Domain name for API request: cdn.tencentcloudapi.com.
This API is used to submit multiple URL purge tasks, which are carried out according to the current acceleration region of the domain names in the URLs.
By default, a maximum of 10,000 URLs can be purged per day for acceleration regions either within or outside Mainland China, and up to 1,000 tasks can be submitted at a time.
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 parameter. The value used for this API: PurgeUrlsCache. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-06-06. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| Urls.N | Yes | Array of String | List of URLs. The protocol header such as "http://" or "https://" needs to be included. |
| Area | No | String | Purging region The acceleration region of the acceleration domain name will be purged if this parameter is not passed in If mainland is passed in, only the content cached on nodes in the Chinese mainland will be purgedIf overseas is passed in, only the content cached on nodes outside the Chinese mainland will be purgedThe specified purging region should match the domain name acceleration region |
| UrlEncode | No | Boolean | Whether to encode Chinese characters before purge. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Purge task ID. URLs submitted in one request share a task ID. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://cdn.tencentcloudapi.com/?Action=PurgeUrlsCache
&Urls.0=http://www.test.com/1.jpg
&<Common request parameters>{
"Response": {
"RequestId": "4d5a83f8-a61f-445b-8036-5636be640bef",
"TaskId": "1533045796-i60rfmzm"
}
}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.CdnConfigError | Failed to update the domain name configuration. |
| InternalError.CdnDbError | Internal data error. Please submit a ticket for troubleshooting. |
| InternalError.CdnSystemError | System error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CdnHostInvalidStatus | Invalid domain name status. |
| InvalidParameter.CdnInterfaceError | Internal API error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CdnParamError | Parameter error. Please see the sample parameters in the documentation. |
| InvalidParameter.CdnPurgeWildcardNotAllowed | Cache purge does not support wildcard domain names. |
| InvalidParameter.CdnStatInvalidDate | Invalid date. Please see the sample date in the documentation. |
| InvalidParameter.CdnUrlExceedLength | The URL exceeds the length limit. |
| LimitExceeded.CdnPurgeUrlExceedBatchLimit | The number of URLs to be purged exceeds the limit. |
| LimitExceeded.CdnPurgeUrlExceedDayLimit | The number of URLs to be purged exceeds the daily limit. |
| ResourceNotFound.CdnHostNotExists | This domain name does not exist under the account. Please check and try again. |
| ResourceNotFound.CdnUserNotExists | The CDN service has not been activated. Please activate it first before using this API. |
| ResourceUnavailable.CdnHostIsNotOnline | The domain name has been deactivated. Prefetch requests cannot be submitted. |
| UnauthorizedOperation.CdnCamUnauthorized | No CAM policy is configured for the sub-account. |
| UnauthorizedOperation.CdnHostUnauthorized | The sub-account has no access to the CDN-accelerated domain name. |
| UnauthorizedOperation.CdnUserAuthFail | Fail to authenticate the CDN user. |
| UnauthorizedOperation.CdnUserAuthWait | The CDN user is pending authentication. |
| UnauthorizedOperation.CdnUserIsSuspended | The CDN service has been suspended. Please restart it and try again. |
| UnauthorizedOperation.OpNoAuth | This operation is not supported currently. Please submit a ticket for assistance. |
Was this page helpful?