1. 接口描述
此接口处于预下线状态 。
预计下线时间:2025-06-30 21:49:25
接口请求域名: teo.tencentcloudapi.com 。
老版本接口,老版本pod的最近一次调用在23年11月
创建清除缓存任务
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreatePurgeTask。 |
Version | 是 | String | 公共参数,本接口取值:2022-01-06。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | Zone ID |
Type | 是 | String | 类型,当前支持的类型: - purge_url:URL - purge_prefix:前缀 - purge_host:Hostname - purge_all:全部缓存 |
Targets.N | 否 | Array of String | 要刷新的资源列表,每个元素格式依据Type而定 1) Type = purge_host 时 形如:www.example.com 或 foo.bar.example.com 2) Type = purge_prefix 时 形如:http://www.example.com/example 3) Type = purge_url 时 形如:https://www.example.com/example.jpg 4)Type = purge_all 时 Targets可为空,不需要填写 |
EncodeUrl | 否 | Boolean | 若有编码转换,仅清除编码转换后匹配的资源 若内容含有非 ASCII 字符集的字符,请开启此开关,编码转换(编码规则遵循 RFC3986) |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
JobId | String | 任务ID |
FailedList | Array of FailReason | 失败的任务列表及原因 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 清除URL
输入示例
输出示例
示例2 清除abc站点下的所有资源
输入示例
输出示例
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.BackendError | 后台处理出错。 |
InternalError.DomainConfig | 获取配置失败。 |
InternalError.QuotaSystem | 配额系统处理失败。 |
InvalidParameter.DomainNotFound | 域名不存在或不属于该账号。 |
InvalidParameter.ParameterError | 参数错误: 无效 "结束时间", 不在允许的查询范围内: [开始时间, 开始+ 7天] |
InvalidParameter.Target | 资源存在错误。 |
InvalidParameter.TaskNotGenerated | 任务无法生成。 |
InvalidParameter.UploadUrl | 文件上传链接存在问题。 |
LimitExceeded.BatchQuota | 本次提交的资源数超过上限。 |
LimitExceeded.DailyQuota | 当天提交的资源数超过上限。 |
OperationDenied | 操作被拒绝。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
UnauthorizedOperation.NoPermission | 子账户没有操作权限,请添加权限后继续操作。 |