DisableCaches

Last updated: 2019-08-21 15:34:02

PDF

1. API Description

API request domain name: cdn.tencentcloudapi.com.

DisableCaches blocks accesses to the specified URL on CDN. After the URL is blocked, The 403 error will be returned, meaning that accessing the page or resource you were trying to reach is absolutely forbidden. (This API is in beta.)

Default API request rate limit: 40 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter, the name of this API: DisableCaches
Version Yes String Common parameter, the version of API: 2018-06-06
Region No String Common parameter; optional for this API.
Urls.N Yes Array of String List of URLs to be blocked
You can submit up to 100 entries at a time and up to 3,000 entries per day

3. Output Parameters

Parameter name Type Description
CacheOptResult CacheOptResult Action result
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Blocking an URL

Input Sample Code

https://cdn.tencentcloudapi.com/?Action=DisableCaches
&Urls.0=http://example.com/path/to.jpg
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "RequestId": "f13cf55b-69e6-4937-8856-bd8965beea8c",
    "CacheOptResult": {
      "SuccessUrls": [
        "http://example.com/path/to.jpg"
      ],
      "FailUrls": []
    }
  }
}

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

TCCLI

6. Error Codes

The following only lists the error codes related to this API. 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.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 Too frequent operations on domain name.
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.
UnauthorizedOperation.CdnAccountUnauthorized The sub-account is unauthorized to query full data.
UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
UnauthorizedOperation.CdnUserAuthFail Fail to authenticate the CDN user.
UnauthorizedOperation.CdnUserAuthWait CDN user authentication is pending .
UnauthorizedOperation.CdnUserIsSuspended The CDN service has been suspended. Please restart it and try again.
UnauthorizedOperation.CdnUserNoWhitelist You are not on the whitelist, so the operation is prohibited.