最近更新时间:2024.03.19 17:55:34
首次发布时间:2022.06.14 21:29:04
查询指定镜像仓库实例下的单个或多个命名空间。
支持通过 Filter 参数控制命名空间的筛选条件。
参数名 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListNamespaces | 公共参数,本接口值:ListNamespaces。 |
Version | String | 是 | 2022-05-12 | 公共参数,本接口值:2022-05-12。 |
Registry | String | 是 | registrya | 指定的镜像仓库实例名称。在 镜像仓库控制台 的 实例列表 页面,获取实例名称。 |
Filter | Object<NamespaceFilter> | 否 | 待查询命名空间的过滤条件,详情请参见 NamespaceFilter。 | |
PageSize | Integer | 否 | 10 | 单页展示的命名空间数量,默认为 10 个,取值范围为 [1,100] 的整数。 |
PageNumber | Integer | 否 | 1 | 开始显示返回结果的页码,从 1 开始,默认为 1,取值范围为 [1,2147483647] 的整数。 |
调用该 API 时,除了上述请求参数外,还需传入公共请求参数。公共请求参数说明,请参见 火山引擎公共参数文档。
POST /?Action=ListNamespaces &Version=2022-05-12 &<公共参数> { "Registry": "registrya", "PageNumber": 1, "PageSize": 20, "Filter": { "Names": ["namespacea"] } }
参数名 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
Registry | string | 是 | registrya | 指定镜像仓库实例名称。 |
TotalCount | Integer | 是 | 1 | 查询到的命名空间数量。 |
Items | List<Namespace> | 是 | 命名空间列表,详情请参见 Namespace。 | |
PageSize | Integer | 是 | 10 | 单页显示的命名空间信息条数。 |
PageNumber | Integer | 是 | 1 | 当前页码。 |
{ "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状态码 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OperationDenied.RegistryStatus | The action has been denied due to wrong status %s. | 当前实例状态下不允许执行该操作,请等待状态转换后重试。 |