1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
查询镜像预热列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePreCacheImageList。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 查询过滤条件。支持 Image, ImageDigest, ImageRegistryType, Status, SourceType;不同 Filter 之间为 AND,同一 Filter 的 Values 之间为 OR。 |
| MaxResults | 否 | Integer | 返回数据列数 取值范围:[1, 100] 默认值:20 示例值:30 |
| NextToken | 否 | String | NextToken是每个页面唯一的分页令牌。使用返回的令牌再次调用以检索下一页。需要保持所有其他参数不变。 示例值:eyJ2IjoxLCJjIjp7IkNyZWF0ZWRBdCI6IjIwMjYtMDktMTBUMTc6NDk6MDkrMDg6MDAiLCJJRCI6MjE5fSwiZiI6Ijc3MjcxY2M1ZDgzZTUyOTc3ODMxNTkyOTRiOTQxZTc2NTVjOGU5ZWU0MzNjZjA3YWIxM2FhNGM0ZDI0ZjliOTYiLCJ0IjoxMTUsImUiOjE3ODkyMTQ5OTF9.p6SVjzxF7gMvY8p1JjsdKhFt13CthONEa30-dARBH30 |
| NeedTotalCount | 否 | Boolean | 默认 false;仅控制是否返回精确总数 示例值:false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 镜像预热总数 示例值:10 |
| PreCacheImageList | Array of PreCacheImage | 镜像预热列表 |
| NextToken | String | 如果NextToken返回非空字符串 ,表示还有更多可用结果。 NextToken是每个页面唯一的分页令牌。使用返回的令牌再次调用以检索下一页。需要保持所有其他参数不变。 示例值:eyJ2IjoxLCJjIjp7IkNyZWF0ZWRBdCI6IjIwMjYtMDktMjFUMTc6MjU6NTMrMDg6MDAiLCJJRCI6NzU2fSwiZiI6ImMyNGE3N2JhYWRmNTFiZDY3YmY1YWNkZDVlM2JlNzRiODc1Y2ZlODQwMjE2NTVlZDIxYWIxNTM2NmFiMjU3ZTQiLCJlIjoxNzkwNjUzNTQzfQ.6zJRI6AWpXvrnIsXXM8bhllwagfhk2KVWN3HUwBFLXM |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 不显示列表总数
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePreCacheImageList
<公共请求参数>
{
"NeedTotalCount": false,
"NextToken": "eyJ2IjoxLCJjIjp7IkNyZWF0ZWRBdCI6IjIwMjYtMDktMTBUMTc6NDk6MDcrMDg6MDAiLCJJRCI6MTk5f*********************************************************************************kxMTVhMWUzOTIiLCJlIjoxNzg5MjE0Njc2fQ.eQLovNAMZZnzPhegzuFjUM6VWhI2Sm-iOjbqtNq5b0M"
}
输出示例
{
"Response": {
"NextToken": "eyJ***********************************************************************************************************************************************************************************************************************************************",
"PreCacheImageList": [
{
"CachedImageSizeBytes": 71188480,
"CreateTime": "2026-09-11T19:41:18+08:00",
"Image": "***.ccs.tencentyun.c***************************:***********",
"ImageDigest": "sha256:****************************************************************",
"ImageRegistryType": "personal",
"PreCacheImageId": "pcimg-jt******",
"SourceType": "AUTO",
"Status": "DELETED"
}
],
"RequestId": "5581962d-4948-45a3-a3c1-16a5ac776798"
}
}
示例2 使用FIlters过滤被卸载的预热镜像
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePreCacheImageList
<公共请求参数>
{
"Filters": [
{
"Name": "status",
"Values": [
"DELETED"
]
}
],
"NeedTotalCount": true
}
输出示例
{
"Response": {
"NextToken": "",
"PreCacheImageList": [
{
"CachedImageSizeBytes": 71188480,
"CreateTime": "2026-09-11T19:41:18+08:00",
"Image": "***.ccs.tencentyun.c***************************:***********",
"ImageDigest": "sha256:****************************************************************",
"ImageRegistryType": "personal",
"PreCacheImageId": "pcimg-jt******",
"SourceType": "AUTO",
"Status": "DELETED"
}
],
"TotalCount": 12,
"RequestId": "34a02fac-3510-4287-9d8b-39dcf9716fa9"
}
}
示例3 使用NextToken进行翻页
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePreCacheImageList
<公共请求参数>
{
"MaxResults": 30,
"NextToken": "eyJ2IjoxLCJjIjp7IkNyZWF0ZWRBdCI6IjIwMjYtMDktMTBUMTc6NDk6MDcrMDg6MDAiLCJJRCI6MTk5fSwiZiI6Ijk0ZjNkNmExYmM3MTBkNjFlZjE0NWQ0N2M1MGVlNDUzNTgwYTlkM2Y5NzFmODlhMzE2NDQ2YzkxMTVhMWUzOTIiLCJlIjoxNzg5MjE0Njc2fQ.eQLovNAMZZnzPhegzuFjUM6VWhI2Sm-iOjbqtNq5b0M",
"NeedTotalCount": false
}
输出示例
{
"Response": {
"NextToken": "ey************************************************************************************************************************************************************************************************************************************************",
"PreCacheImageList": [
{
"CachedImageSizeBytes": 23498752,
"CreateTime": "2026-09-10T17:49:06+08:00",
"Image": "***.ccs.tencentyun.com/***********/**************:***********************",
"ImageDigest": "sha256:fa48016d02709c6cc************************a0b3a4bd89c993eff799d3b",
"ImageRegistryType": "personal",
"PreCacheImageId": "pcimg-38******",
"SourceType": "EXPLICIT",
"Status": "SUCCESS"
}
],
"RequestId": "505d7fed-369a-4f99-a53f-5e7212a569d7"
}
}
示例4 显示列表总数
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePreCacheImageList
<公共请求参数>
{
"NeedTotalCount": true
}
输出示例
{
"Response": {
"NextToken": "ey**********************************************************************************************************************************************************************************************************************************************************",
"PreCacheImageList": [
{
"CachedImageSizeBytes": 71188480,
"CreateTime": "2026-09-11T19:41:18+08:00",
"Image": "ccr.ccs.tencentyun.c********************che-e2e:template-v1",
"ImageDigest": "sha256:d7796f8d4270158b2************************49607bdd8a95ebd606c4047",
"ImageRegistryType": "personal",
"PreCacheImageId": "pcimg*****6yra",
"SourceType": "AUTO",
"Status": "DELETED"
}
],
"TotalCount": 115,
"RequestId": "4ef2fa42-5e15-49ab-9708-eccc415fe1c5"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.DependencyUnavailable | 依赖服务不可用或超时 |
| InternalError.Unknown | 未分类内部错误 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |