1. 接口描述
接口请求域名: cdn.tencentcloudapi.com 。
该接口已废弃
DisableCaches 用于禁用 CDN 上指定 URL 的访问,禁用完成后,中国境内访问会直接返回 403。
默认接口请求频率限制:40次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DisableCaches。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-06。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Urls.N | 是 | Array of String | 禁用的 URL 列表(分协议生效,必须包含http://或https://) 每次最多可提交 100 条,每日最多可提交 3000 条 示例值:http://www.test.com/1.txt |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CacheOptResult | CacheOptResult | 提交结果 注意:此字段可能返回 null,表示取不到有效值。 |
TaskId | String | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 封禁示例
输入示例
https://cdn.tencentcloudapi.com/?Action=DisableCaches
&Urls.0=http://example.com/path/to.jpg
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "f13cf55b-69e6-4937-8856-bd8965beea8c",
"CacheOptResult": {
"SuccessUrls": [
"http://example.com/path/to.jpg"
],
"FailUrls": []
},
"TaskId": "123"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.CdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 |
InternalError.CdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.CDNStatusInvalidDomain | 域名状态不合法。 |
InvalidParameter.CdnHostInvalidParam | 域名格式不合法,请确认后重试。 |
InvalidParameter.CdnHostInvalidStatus | 域名状态不合法。 |
InvalidParameter.CdnInterfaceError | 内部接口错误,请联系腾讯云工程师进一步排查。 |
InvalidParameter.CdnParamError | 参数错误,请参考文档中示例参数填充。 |
InvalidParameter.CdnStatInvalidDate | 日期不合法,请参考文档中日期示例。 |
InvalidParameter.CdnStatInvalidProjectId | 项目ID错误,请确认后重试。 |
LimitExceeded.CdnHostOpTooOften | 域名操作过于频繁。 |
LimitExceeded.CdnPushExceedDayLimit | 预热的Url数量超过每日限制。 |
ResourceNotFound.CdnHostNotExists | 未查询到该域名,请确认域名是否正确。 |
ResourceNotFound.CdnUserNotExists | 未开通CDN服务,请开通后使用此接口。 |
UnauthorizedOperation.CdnAccountUnauthorized | 子账号禁止查询整体数据。 |
UnauthorizedOperation.CdnCamUnauthorized | 子账号未配置cam策略。 |
UnauthorizedOperation.CdnHostUnauthorized | CDN子账号加速域名未授权。 |
UnauthorizedOperation.CdnUserAuthFail | CDN用户认证失败。 |
UnauthorizedOperation.CdnUserAuthWait | CDN用户待认证。 |
UnauthorizedOperation.CdnUserIsSuspended | 加速服务已停服,请重启加速服务后重试。 |
UnauthorizedOperation.CdnUserNoWhitelist | 非内测白名单用户,无该功能使用权限。 |
UnauthorizedOperation.OperationTooOften | 操作超出调用频次限制。 |