1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
更新镜像预热自动卸载策略
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdatePreCacheImageCleanupPolicy。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| CleanupPolicyId | 是 | String | 清理策略ID 示例值:pccp-fipjvbm0 |
| Name | 否 | String | 清理策略名 示例值:example2 |
| RegistryHost | 否 | String | 镜像仓库地址 入参限制:精准匹配,不传或空串表示不限,最多 255 字符 示例值:tcr-cq.tencentcloudcr.com |
| RepoPattern | 否 | String | 镜像仓库名 入参限制:正则匹配,最多 256 字符,编译后指令数不超过 128,账号全部启用策略合计不超过 1280。不传或空串表示全部 Repo。 示例值:example/* |
| IdleTTL | 否 | String | 闲置过期时间 参数格式:正数 m/h/d 示例值:10d |
| Enabled | 否 | Boolean | 策略启用配置 枚举值:
默认值:true 示例值:false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CleanupPolicy | PreCacheImageCleanupPolicy | 清理策略详情 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新镜像预热自动清理策略
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdatePreCacheImageCleanupPolicy
<公共请求参数>
{
"CleanupPolicyId": "pccp-fipjvbm0",
"RegistryHost": "tcr-cq.tencentcloudcr.com",
"RepoPattern": "example/*",
"Enabled": false
}
输出示例
{
"Response": {
"CleanupPolicy": {
"CleanupPolicyId": "pccp-fipjvbm0",
"CreateTime": "2026-11-17T08:30:48Z",
"Enabled": false,
"IdleTTL": "3d",
"Name": "example",
"RegistryHost": "tcr-cq.tencentcloudcr.com",
"RepoPattern": "example/*",
"UpdateTime": "2026-11-17T08:36:20Z"
},
"RequestId": "71677a5f-4661-4b84-a30d-00b705f52aba"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |