1. 接口描述
接口请求域名： ags.tencentcloudapi.com 。
查询镜像预热任务信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribePreCacheImageTask。 |
| Version | 是 | String | 公共参数，本接口取值：2025-09-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Image | 否 | String | 镜像地址 示例值：nginx:latest |
| ImageRegistryType | 否 | String | 镜像仓库类型： 枚举值：
示例值：enterprise |
| ImageDigest | 否 | String | 镜像 Digest 示例值：sha256:abcdefg123... |
| PreCacheImageId | 否 | String | 镜像预热ID，只能ID或三元组（Image、ImageDigest、ImageRegistrytype）二选一查询 示例值：pcimg-00001 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Image | String | 镜像地址 示例值：nginx:latest |
| ImageDigest | String | 镜像 Digest 示例值：sha256:abcdefg123... |
| ImageRegistryType | String | 镜像仓库类型： 示例值：enterprise |
| Status | String | 镜像预热状态 示例值：Success |
| Message | String | 镜像预热状态描述 示例值：镜像预热成功 |
| CreateTime | String | 镜像预热创建时间 示例值：2026-09-11T16:41:57+08:00 |
| PreCacheImageId | String | 镜像预热ID 示例值：pcimg-00001 |
| SourceType | String | 镜像预热资源的来源类型，取值为 EXPLICIT、AUTO 枚举值：
示例值：EXPLICIT |
| CachedImageSizeBytes | Integer | 镜像预热存储大小 单位：Byte 示例值：3523604480 |
| LastUsedTime | String | 该预热镜像最近一次被沙箱实例使用时间 示例值：2026-09-11T18:04:36+08:00 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 按PreCacheImageId查询预热镜像
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePreCacheImageTask
<公共请求参数>
{
"PreCacheImageId": "pcimg-qi3p****"
}输出示例
{
"Response": {
"CachedImageSizeBytes": 3523604480,
"CreateTime": "2026-09-11T16:41:57+08:00",
"Image": "***.ccs.tencentyun.com/*********/************************:*****",
"ImageDigest": "sha256:*************",
"ImageRegistryType": "personal",
"LastUsedTime": "2026-09-11T18:04:36+08:00",
"Message": "Image precache completed successfully",
"PreCacheImageId": "pcimg-qi3p****",
"SourceType": "EXPLICIT",
"Status": "Success",
"RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}示例2 查询用户 VPC 可达第三方镜像预热状态
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePreCacheImageTask
<公共请求参数>
{
"Image": "harbor.internal.example.com/team/app:1.0",
"ImageDigest": "sha256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"ImageRegistryType": "custom"
}输出示例
{
"Response": {
"Image": "harbor.internal.example.com/team/app:1.0",
"ImageDigest": "sha256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"ImageRegistryType": "custom",
"Status": "Success",
"Message": "conversion-backed precache completed",
"RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}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 | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.Unknown | 未分类内部错误 |
| InvalidParameterValue.Image | 镜像地址无效 |
| InvalidParameterValue.Scope | 参数 Scopes 取值无效，或当前地域不支持指定的镜像预热范围。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.Image | 镜像不存在 |
