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

ListRegistries

最近更新时间2024.03.19 17:55:34

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

查询一个或多个镜像仓库实例。

使用说明

查询镜像仓库实例时,通过 Filter 参数,控制镜像仓库实例的筛选条件。

请求参数

参数名类型是否必须示例值描述
ActionStringListRegistries公共参数,本接口值:ListRegistries。
VersionString2022-05-12公共参数,本接口值:2022-05-12。
FilterObject<RegistryFilter>待查询镜像仓库实例的过滤条件。详细说明,请参见RegistryFilter
PageSizeInteger10单页展示的镜像仓库实例数量,默认为 10 个,取值范围为 [1,100] 的整数。
PageNumberInteger1开始显示返回结果的页码,从 1 开始,默认为 1,取值范围为 [1,2147483647] 的整数。

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

请求示例

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

Body
{
    "Filter": {
        "Names": ["example"]
    }
}

返回参数

参数名类型示例描述
TotalCountInteger1查询到的镜像仓库实例数量。
ItemsList<Registry>镜像仓库实例列表,详情请参见 Registry
PageSizeInteger10单页显示的镜像仓库实例信息条数。
PageNumberInteger1当前页码。

返回示例

{
    "ResponseMetadata" : {
        "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
        "Action": "ListRegistries",
        "Version": "2022-05-12",
        "Service": "cr",
        "Region": "cn-beijing",
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "Items": [
            {
                "Name": "example",
                "Type": "Enterprise",
                "Status": {
                    "Phase": "Running",
                    "Conditions": ["ok"]
                },
                "CreateTime": "2022-05-20T13:00:55Z"
            }
        ]
    }
}

错误码

本接口无特有错误码,公共错误码请参见 公共错误码