ListTags--镜像仓库-火山引擎

文档中心

立即注册

导航

ListTags

最近更新时间：2024.11.28 11:20:01首次发布时间：2022.06.14 21:29:04

查询指定 OCI 制品仓库下的一个或多个 OCI 制品（镜像、Helm Chart）版本。

接口说明

查询 OCI 制品版本时，通过 Filter 参数，控制 OCI 制品版本的筛选条件。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListTags&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时，除了以下请求参数外，还需传入公共请求参数。公共请求参数说明，请参见火山引擎公共参数文档。

参数	类型	是否必选	示例值	描述
Action	String	是	ListTags	接口名称。当前 API 的名称为 `ListTags`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
Registry	String	是	registrya	指定 OCI 制品仓库所属的镜像仓库实例名称。在镜像仓库控制台的实例列表页面，获取实例名称。
Namespace	String	是	library	指定 OCI 制品仓库所属的命名空间名称。在镜像仓库控制台目标实例的命名空间页面，获取命名空间名称。
Repository	String	是	repositorya	指定 OCI 制品仓库名称。在镜像仓库控制台目标实例的 OCI制品仓库页面，获取 OCI 制品仓库名称。
Filter	Object of TagFilter	否		查询 OCI 制品版本的过滤条件。
PageSize	Long	否	10	单页展示的 OCI 制品版本数量，默认为 10 个，取值范围为 [1,100] 的整数。
PageNumber	Long	否	1	开始显示返回结果的页码，从 1 开始，默认为 1。取值范围为 [1,2147483647] 的整数。

TagFilter

参数	类型	是否必选	示例值	描述
Names	Array of String	否	["tag"]	指定 Tag，支持精确匹配和模糊匹配，模糊匹配仅支持使用 * 号作为通配符，最多 20 个。
Types	Array of String	否	["Image"]	OCI 制品 Tag 类型，取值如下： Image：该 Tag 对应一个容器镜像。 Chart：该 Tag 对应一个 Helm Chart。单次可填写一个或多个Tag 类型。

参数

类型

是否必选

示例值

描述

Names

Array of String

否

["tag"]

指定 Tag，支持精确匹配和模糊匹配，模糊匹配仅支持使用 * 号作为通配符，最多 20 个。

Types

Array of String

否

["Image"]

OCI 制品 Tag 类型，取值如下：

Image：该 Tag 对应一个容器镜像。
Chart：该 Tag 对应一个 Helm Chart。
单次可填写一个或多个Tag 类型。

请求示例

POST https://open.volcengineapi.com?Action=ListTags&Version=2022-05-12
{
    "Registry": "registrya",
    "Namespace": "library",
    "Repository": "repositorya",
    "PageSize": 2,
    "PageNumber": 1,
    "Filter": {
        "Names": ["taga"],
        "Types": ["Image"]
    }
}

返回参数

参数	类型	示例值	描述
Registry	String	registrya	指定 OCI 制品仓库所属的镜像仓库实例名称。
TotalCount	Long	1	查询到的 OCI 制品版本总数。
Namespace	String	library	指定 OCI 制品仓库所属的命名空间名称。
Repository	String	repositorya	指定 OCI 制品仓库名称。
Items	Array of Tag		OCI 制品版本列表。详细信息，请参见 Tag。
PageNumber	Long	1	当前页码。
PageSize	Long	10	单页显示的 OCI 制品版本信息条数。

Tag

参数	类型	示例值	描述
Name	String	v2	OCI 制品版本（Tag）名称。
Type	String	Image	OCI 制品 Tag 类型： Image：该 Tag 对应一个容器镜像。 Chart：该 Tag 对应一个 Helm Chart。
Digest	String	sha256:dd97a3eb42********	OCI 制品摘要，SHA256 值。
PushTime	String	2022-05-03T12:08:01Z	OCI 制品最近一次推送的时间。RFC3339 格式的 UTC+0 时间。
Size	Long	10061844	OCI 制品大小，单位为 Byte。
ImageAttributes	Array of ImageAttribute		Tag 类型为 Image 时的相关属性。
ChartAttribute	Object of ChartAttribute		Tag 类型为 Chart 时的相关属性。

ImageAttribute

参数	类型	示例值	描述
Author	String	user@test.com	镜像的创建者，即上传该镜像到镜像仓库的火山引擎账号。
Architecture	String	amd64	镜像架构。
Os	String	linux	镜像支持的操作系统。
Digest	String	sha256:dd97a3eb42********	镜像摘要，SHA256 值。
Size	Long	213587000	镜像大小

ChartAttribute

参数	类型	示例值	描述
ApiVersion	String	v2	Helm 版本。
Name	String	helm1	Helm Chart 名称。
Version	String	8.6.1	Helm Chart 版本。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
        "Action": "ListTags",
        "Version": "2022-05-12",
        "Service": "cr",
        "Region": "cn-beijing"
    },
    "Result": {
        "Registry": "registrya",
        "Namespace": "library",
        "Repository": "repositorya",
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "Items": [
            {
                "Digest": "sha256:318693f46bd015fa7e1652cff99728ab91403d0922af1183a8ad15ee********",
                "Type": "Image",
                "PushTime": "2021-08-26T06:04:29Z",
                "Size": 4389,
                "Name": "0.0.2",
                "ImageAttributes": [
                    {
                        "Author": "",
                        "Architecture": "amd64",
                        "Os": "linux",
                        "Digest": "xxxxxx"
                    }
                ]
            }
        ]
    }
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	OperationDenied.RegistryStatus	The action has been denied due to wrong status %s.	当前实例状态下不允许执行指定操作，请等待状态转换后重试。