You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

ListNamespaces

最近更新时间2023.04.26 10:22:31

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

查询指定镜像仓库实例下的单个或多个命名空间。

使用说明

支持通过 Filter 参数控制命名空间的筛选条件。

请求参数

参数名类型是否必须示例值描述
ActionStringListNamespaces公共参数,本接口值:ListNamespaces。
VersionString2022-05-12公共参数,本接口值:2022-05-12。
RegistryStringregistrya指定的镜像仓库实例名称。在 镜像仓库控制台实例列表 页面,获取实例名称。
FilterObject<NamespaceFilter>待查询命名空间的过滤条件,详情请参见 NamespaceFilter
PageSizeInteger10单页展示的命名空间数量,默认为 10 个。
PageNumberInteger1开始显示返回结果的页码,从 1 开始,默认为 1。

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

请求示例

POST /?Action=ListNamespaces
&Version=2022-05-12
&<公共参数>
{
    "Registry": "registrya",
    "PageNumber": 1,
    "PageSize": 20,
    "Filter": {
        "Names": ["namespacea"]
    }
}

返回参数

参数名类型是否必须示例值描述
Registrystringregistrya指定镜像仓库实例名称。
TotalCountInteger1查询到的命名空间数量。
ItemsList<Namespace>命名空间列表,详情请参见 Namespace
PageSizeInteger10单页显示的命名空间信息条数。
PageNumberInteger1当前页码。

返回示例

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

错误码

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

HTTP状态码错误码错误信息描述
400OperationDenied.RegistryStatusThe action has been denied due to wrong status %s.当前实例状态下不允许执行该操作,请等待状态转换后重试。