You need to enable JavaScript to run this app.
导航
ListNamespaces
最近更新时间:2024.09.27 11:28:29首次发布时间:2022.06.14 21:29:04

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

接口说明

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

请求说明

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

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringListNamespaces接口名称。当前 API 的名称为 ListNamespaces
VersionString2022-05-12接口版本。当前 API 的版本为 2022-05-12
RegistryStringregistrya指定的镜像仓库实例名称。在 镜像仓库控制台实例列表 页面,获取实例名称。
FilterObject of NamespaceFilter待查询命名空间的过滤条件。
PageSizeLong10单页展示的命名空间数量,默认为 10 个,取值范围为 [1,100] 的整数。
PageNumberLong1开始显示返回结果的页码,从 1 开始,默认为 1,取值范围为 [1,2147483647] 的整数。

NamespaceFilter

参数类型是否必选示例值描述

Names

Array of String

["ns1","ns2"]

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

请求示例

POST https://open.volcengineapi.com?Action=ListNamespaces&Version=2022-05-12
{
    "Registry": "registrya",
    "PageNumber": 1,
    "PageSize": 20,
    "Filter": {
        "Names": ["namespacea"]
    }
}

返回参数

参数类型示例值描述
RegistryStringregistrya指定镜像仓库实例名称。
TotalCountLong1查询到的命名空间数量。
PageNumberLong1当前页码。
PageSizeLong10单页显示的命名空间信息条数。
ItemsArray of Namespace命名空间列表,详情请参见 Namespace

Namespace

参数类型示例值描述
NameStringnamespacea命名空间名称。
ProjectStringprojectaNamespace 所属项目的名称。该参数为空时,表示创建的 Namespace 不属于任何项目。
CreateTimeString2022-05-20T13:00:55Z创建命名空间的时间。RFC3339 格式的 UTC+0 时间。

返回示例

{
    "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.当前实例状态下不允许执行指定操作,请等待状态转换后重试。