容器镜像服务查询容器镜像信息-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tcr.tencentcloudapi.com 。

查询镜像版本列表或指定容器镜像信息

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeImages。
Version	是	String	公共参数，本接口取值：2019-09-24。
Region	是	String	公共参数，详见产品支持的地域列表。
RegistryId	是	String	实例ID 示例值：tcr-okmj78
NamespaceName	是	String	命名空间名称示例值：team-01
RepositoryName	是	String	镜像仓库名称示例值：nginx
ImageVersion	否	String	指定镜像版本进行查找，当前为模糊搜索示例值：1.0
Limit	否	Integer	每页个数，用于分页，默认20 示例值：20
Offset	否	Integer	页数，默认值为1 补充说明：limit指的是每页的大小，offset指的是具体第几页。举例：limit 20 offset 1指的是1-20；limit 20 offset 2 指的是21-40；limit 30 offset 4 是指 90-120。示例值：1
Digest	否	String	指定镜像 Digest 进行查找示例值：sha256:a1801b843b1bfaf77c501e7a6d3f709401a1e0c83863037fa3aab063a
ExactMatch	否	Boolean	指定是否为精准匹配，true为精准匹配，不填为模糊匹配示例值：false

3. 输出参数

参数名称	类型	描述
ImageInfoList	Array of TcrImageInfo	容器镜像信息列表
TotalCount	Integer	容器镜像总数示例值：2
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询容器镜像信息

查询指定镜像仓库内全部容器镜像信息，获取镜像版本列表

输入示例

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

{
    "Limit": "20",
    "NamespaceName": "team-01",
    "RepositoryName": "nginx",
    "RegistryId": "tcr-okmj78",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "d76f7a1b-d9e9-4454-b95b-25c34f17b943",
        "ImageInfoList": [
            {
                "Digest": "sha256:a1801b843b1bfaf77c501e7a6d3f709401a1e0c83863037fa3aab063a7fdb9dc",
                "ImageVersion": "8",
                "Size": 83520757,
                "UpdateTime": "2022-08-06T07:31:01.207374Z",
                "Kind": "Artifact::application/vnd.docker.distribution.manifest.v2+json",
                "KmsSignature": "UKauWpHdjaTjTsE64BSFhJe0YZj7eXiu8DzkRgTk0vbuxl+ICYbVJ2p1afHGv/WsOqqJvEKJdNPU4iAGNYEbegTi/UwcrCRijNeFkzHNqljBa75g1u9LHjVmtE9dxzh17YGRHpDxbL2CCjZ9YgeCqppsl1LiXvlYdrMLgoqwHKwao3WnkZU2fye4HIreZ3CXGkjv7g8rbhmjwEZJUTWAuEws7eNSvl9RS8NAJctwvZWZQUGKkRpbBRkKxdENSIgRoA+SyX0Qmu2SxvwDRTsCwI+B1rJxLmw1wYgAh3mQiXtehBZAJdYLcOvokUgAUC8cpKpeJ+bSsYvCLh+uJlF4Pg=="
            }
        ],
        "TotalCount": 1
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.DependenceError	依赖服务异常。
FailedOperation.EmptyCoreBody	Core 返回内容为空
InternalError	内部错误。
InternalError.DbError	数据库错误。
InternalError.ErrorTcrInternal	Tcr实例内部错误。
InternalError.ErrorTcrInvalidMediaType	Tcr实例请求无效的Hearder类型。
InternalError.ErrorTcrResourceConflict	Tcr实例资源冲突。
InternalError.ErrorTcrUnauthorized	没有Tcr操作权限。
InvalidParameter	参数错误。
InvalidParameter.ErrorTcrInvalidParameter	无效的TCR请求。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。
ResourceNotFound.TcrResourceNotFound	Tcr实例中的资源未找到。
UnsupportedOperation	操作不支持。

查询容器镜像信息

本页目录：