You need to enable JavaScript to run this app.
导航

ListTags

最近更新时间2024.03.19 17:29:37

首次发布时间2022.06.14 21:29:04

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

使用说明

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

请求参数

参数名类型是否必须示例值描述
ActionStringListTags公共参数,本接口值:ListTags。
VersionString2022-05-12公共参数,本接口值:2022-05-12。
RegistryStringregistrya指定 OCI 制品仓库所属的镜像仓库实例名称。在 镜像仓库控制台实例列表 页面,获取实例名称。
NamespaceStringlibrary指定 OCI 制品仓库所属的命名空间名称。在 镜像仓库控制台 目标实例的 命名空间 页面,获取命名空间名称。
RepositoryStringrepositorya指定 OCI 制品仓库名称。在 镜像仓库控制台 目标实例的 OCI制品仓库 页面,获取 OCI 制品仓库名称。
FilterObject<TagFilter>查询 OCI 制品版本的过滤条件。详细信息,请参见 TagFilter
PageSizeInteger10单页展示的 OCI 制品版本数量,默认为 10 个,取值范围为 [1,100] 的整数。
PageNumberInteger1开始显示返回结果的页码,从 1 开始,默认为 1。取值范围为 [1,2147483647] 的整数。

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

请求示例

POST /?Action=ListTags
&Version=2022-05-12
&<公共参数>

Body
{
    "Registry": "registrya",
    "Namespace": "library",
    "Repository": "repositorya",
    "PageSize": 2,
    "PageNumber": 1,
    "Filter": {
        "Names": ["taga"],
        "Types": ["Image"]
    }
}

返回参数

参数名类型示例值描述
RegistryStringregistrya指定 OCI 制品仓库所属的镜像仓库实例名称。
NamespaceStringlibrary指定 OCI 制品仓库所属的命名空间名称。
RepositoryStringrepositorya指定 OCI 制品仓库名称。
TotalCountInteger1查询到的 OCI 制品版本总数。
ItemsList<Tag>OCI 制品版本列表。详细信息,请参见 Tag
PageSizeInteger10单页显示的 OCI 制品版本信息条数。
PageNumberInteger1当前页码。

返回示例

{
    "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状态码错误码错误信息处理措施
400OperationDenied.RegistryStatusThe action has been denied due to wrong status %s.当前实例状态下不允许执行指定操作,请等待状态转换后重试。