查询容器镜像信息

最近更新时间: 2026-09-17 00:02:56

1. 接口描述

接口请求域名： tcr.api3.fincloud.tencent.cn。

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

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

接口更新时间：2023-09-05 10:07:01。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeImages
Version	是	否	String	公共参数，本接口取值：2019-09-24
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
RegistryId	是	否	String	实例ID 示例值：
NamespaceName	是	否	String	命名空间名称示例值：
RepositoryName	是	否	String	镜像仓库名称示例值：
ImageVersion	否	否	String	指定镜像版本进行查找，当前为模糊搜索示例值：
Limit	否	否	Int64	每页个数，用于分页，默认20 示例值：
Offset	否	否	Int64	页数，默认值为1 示例值：
Digest	否	否	String	指定镜像 Digest 进行查找示例值：
ExactMatch	否	否	Bool	指定是否为精准匹配，true为精准匹配，不填为模糊匹配示例值：

3. 输出参数

参数名称	类型	描述
ImageInfoList	Array of TcrImageInfo	容器镜像信息列表示例值：查看
TotalCount	Int64	容器镜像总数示例值：
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
MissingParameter	缺少参数错误。
InternalError	内部错误。
InvalidParameter	参数错误。
InternalError.DbError	数据库错误。
InternalError.ErrorTcrInternal	Tcr实例内部错误。
InternalError.ErrorTcrUnauthorized	没有Tcr操作权限。
InvalidParameter.ErrorTcrInvalidParameter	无效的TCR请求。
ResourceNotFound.TcrResourceNotFound	Tcr实例中的资源未找到。
ResourceNotFound	资源不存在。
InternalError.ErrorTcrResourceConflict	Tcr实例资源冲突。
InternalError.ErrorTcrInvalidMediaType	Tcr实例请求无效的Hearder类型。
OperationDenied	操作被拒绝。
FailedOperation	操作失败。

5. 示例

示例1 查询容器镜像信息

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

输入示例

POST / HTTP/1.1
Host: tcr.api3.fincloud.tencent.cn
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
    }
}