DisableCaches

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.

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: 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.

3. Output Parameters

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.

4. Example

Example1 Blocking a URL

Input Example

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

Output Example

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

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

Tencent Cloud CLI 3.0

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.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.

Yes

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Voice Technology

Internet of Things

Stream Services

Cloud Real-time Rendering

Cloud Resource Management

More

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Management and Audit Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Image Creation

Natural Language Processing

Communication

Media Process Services

Education Sevices

Developer Tools

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Tencent Big Model

Optical Character Recognition

Interactive Video Services

Media SDK

Medical Services

Monitor and Operation

1. API Description