Release Notes
Announcements
Domain name for API request: cdn.intl.tencentcloudapi.com.
This API is used to block access to a specific URL on CDN. When a URL is blocked, error 403 will be returned for requests from the Chinese mainland. URL blocking is not permanent. Note that this API is only available to beta users now.
A maximum of 40 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: DisableCaches. |
| Version | Yes | String | Common Params. The value used for this API: 2018-06-06. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Urls.N | Yes | Array of String | List of URLs to be blocked (URLs must contain http:// or https://).Up to 100 entries can be submitted at a time and 3,000 entries per day. |
| Parameter Name | Type | Description |
|---|---|---|
| CacheOptResult | CacheOptResult | Submission result Note: this field may return null, indicating that no valid values can be obtained. |
| TaskId | String | Task ID Note: This field may return null, indicating that no valid value can be obtained. |
| 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. |
https://cdn.intl.tencentcloudapi.com/?Action=DisableCaches
&Urls.0=http://example.com/path/to.jpg
&<Common request parameters>{
"Response": {
"RequestId": "f13cf55b-69e6-4937-8856-bd8965beea8c",
"CacheOptResult": {
"SuccessUrls": [
"http://example.com/path/to.jpg"
],
"FailUrls": []
},
"TaskId": "xx"
}
}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.CdnDbError | Internal data error. Please submit a ticket for troubleshooting. |
| InternalError.CdnSystemError | System error. Please submit a ticket for troubleshooting. |
| InvalidParameter.CDNStatusInvalidDomain | Invalid domain name status. |
| InvalidParameter.CdnHostInvalidParam | Invalid domain name format. Please check and try again. |
| 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.CdnStatInvalidDate | Invalid date. Please see the sample date in the documentation. |
| InvalidParameter.CdnStatInvalidProjectId | Incorrect project ID. Please check and try again. |
| LimitExceeded.CdnHostOpTooOften | Domain name operations are too frequent. |
| LimitExceeded.CdnPushExceedDayLimit | The number of URLs to be prefetched exceeds the daily limit. |
| ResourceNotFound.CdnHostNotExists | Unable to find the domain name. Please make sure the domain name is correct. |
| ResourceNotFound.CdnUserNotExists | The CDN service has not been activated. Please activate it first before using this API. |
| UnauthorizedOperation.CdnAccountUnauthorized | The sub-account is unauthorized to query full data. |
| 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.CdnUserNoWhitelist | You are not in the beta whitelist and thus have no permission to use this function. |
| UnauthorizedOperation.OperationTooOften | Too many calling attempts. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback