帮你快速理解、总结文档立即下载
文档中心>Agent Runtime>API 文档>镜像预热相关接口>查询镜像预热自动清理策略

查询镜像预热自动清理策略

最近更新时间:2026-11-20 19:49:14
我的收藏

1. 接口描述

接口请求域名: ags.tencentcloudapi.com 。

查询镜像预热自动卸载策略

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribePreCacheImageCleanupPolicyList。
Version 是 String 公共参数,本接口取值:2025-09-20。
Region 是 String 公共参数,详见产品支持的 地域列表。
CleanupPolicyIds.N 否 Array of String

策略 ID 列表

入参限制:最多 100 个,每个 1~64 字符;指定时 Offset、Limit、Filters 不生效,不存在或已删除的 ID 被忽略


示例值:["pccp-peuhhczu"]
Filters.N 否 Array of Filter

过滤器

入参限制:Filter={Name:String,Values:String[]};最多 10 个 Filter,每个 Filter 的 Name 和 Values 必填,Values 最多 10 个、每个最多 255 字符

Offset 否 Integer

偏移值

默认值:0


示例值:5
Limit 否 Integer

返回数量限制

取值范围:[1, 100]

默认值:20


示例值:100

3. 输出参数

参数名称 类型 描述
CleanupPolicySet Array of PreCacheImageCleanupPolicy

清理策略集合

TotalCount Integer

返回策略数

单位:个


示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 按ID查询镜像预热清理策略

输入示例

POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePreCacheImageCleanupPolicyList
<公共请求参数>

{
    "CleanupPolicyIds": [
        "pccp-peuhhczu"
    ]
}

输出示例

{
    "Response": {
        "CleanupPolicySet": [
            {
                "CleanupPolicyId": "pccp-peuhhczu",
                "CreateTime": "2026-11-17T08:27:41Z",
                "Enabled": true,
                "IdleTTL": "1d",
                "Name": "example2",
                "RegistryHost": "tcr-cq.tencentcloudcr.com",
                "RepoPattern": "test/*",
                "UpdateTime": "2026-11-17T08:28:13Z"
            }
        ],
        "TotalCount": 1,
        "RequestId": "84861c4e-e29f-443b-a952-0120053f31e6"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。