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

文档中心

立即注册

导航

ListRepositories

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

查询指定镜像仓库实例下的一个或多个 OCI 制品仓库。

接口说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

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

RepositoryFilter

参数	类型	是否必选	示例值	描述
Namespaces	Array of String	否	["ns1","ns2"]	指定 OCI 制品仓库所属的命名空间。在镜像仓库控制台目标实例的命名空间页面，获取命名空间名称。支持精确匹配和模糊匹配，模糊匹配仅支持使用星号（*）作为通配符。单次最多填写 20 个命名空间名称。
Names	Array of String	否	["repo1","repo2"]	指定 OCI 制品仓库名称。在镜像仓库控制台目标实例的 OCI制品仓库页面，获取 OCI 制品仓库名称。支持精确匹配和模糊匹配，模糊匹配仅支持使用星号（*）作为通配符。单次最多填写 20 个 OCI 制品仓库名称。
AccessLevels	Array of String	否	Public	访问等级，取值如下： Private：私有类型 OCI 制品仓库，只能被有权限的用户访问。 Public：公有类型 OCI 制品仓库，可以被所有用户访问。单次可填写一个或多个访问等级。

参数

类型

是否必选

示例值

描述

Namespaces

Array of String

否

["ns1","ns2"]

指定 OCI 制品仓库所属的命名空间。在镜像仓库控制台目标实例的 命名空间 页面，获取命名空间名称。
支持精确匹配和模糊匹配，模糊匹配仅支持使用星号（*）作为通配符。单次最多填写 20 个命名空间名称。

Names

Array of String

否

["repo1","repo2"]

指定 OCI 制品仓库名称。在镜像仓库控制台目标实例的 OCI制品仓库 页面，获取 OCI 制品仓库名称。
支持精确匹配和模糊匹配，模糊匹配仅支持使用星号（*）作为通配符。单次最多填写 20 个 OCI 制品仓库名称。

AccessLevels

Array of String

否

Public

访问等级，取值如下：

Private：私有类型 OCI 制品仓库，只能被有权限的用户访问。
Public：公有类型 OCI 制品仓库，可以被所有用户访问。
单次可填写一个或多个访问等级。

请求示例

POST https://open.volcengineapi.com?Action=ListRepositories&Version=2022-05-12
{
    "Registry": "registrya",
    "PageSize": 20,
    "PageNumber": 3,
    "Filter": {
        "Namespaces": ["library"],
        "Names": ["repositorya"],
        "AccessLevels": ["Private"]
    }
}

返回参数

参数	类型	示例值	描述
Registry	String	registrya	镜像仓库实例
TotalCount	Long	1	镜像实例总数
Items	Array of Repository		OCI 制品仓库列表。详细信息，请参见 Repository。
PageSize	Long	10	单页显示的 OCI 制品仓库信息条数。
PageNumber	Long	1	当前页码。

Repository

参数	类型	示例值	描述
Namespace	String	ns1	命名空间名称。
Name	String	repo1	OCI 制品仓库名称。
AccessLevel	String	Private	访问等级： Private：私有类型 OCI 制品仓库，访问时需要访问密钥。 Public：公有类型 OCI 制品仓库，支持通过访问地址直接访问。
Description	String	it is a description	镜像仓库描述，描述长度为 0~300 个 UTF-8 字符。
CreateTime	String	2022-05-20T13:00:55Z	创建 OCI 制品仓库的时间。RFC3339 格式的 UTC+0 时间。
UpdateTime	String	2022-05-20T13:00:55Z	最近一次更新 OCI 制品仓库的时间。RFC3339 格式的 UTC+0 时间。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
        "Action": "ListRepositories",
        "Version": "2022-05-12",
        "Service": "cr",
        "Region": "cn-beijing",
    },
    "Result": {
        "TotalCount": 1,
        "Registry": "registrya",
        "PageSize": 10,
        "PageNumber": 1,
        "Items": [
            {
                "Namespace": "library",
                "Name": "repositorya",
                "AccessLevel": "Private",
                "CreateTime": "2020-05-20T13:00:55Z",
                "UpdateTime": "2020-05-20T13:00:55Z"
            }
        ]
    }
}

错误码

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

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