You need to enable JavaScript to run this app.
文档中心
镜像仓库

镜像仓库

复制全文
下载 pdf
命名空间管理
ListNamespaces
复制全文
下载 pdf
ListNamespaces
查询指定镜像仓库实例下的单个或多个命名空间。​
接口说明​
支持通过 Filter参数控制命名空间的筛选条件。​
请求说明​
为获得低延迟,建议您根据资源所在的地域选择对应的服务地址,详情参见 服务地址。​
  • 请求方式:POST​
  • 请求地址:https://cr.cn-beijing.volcengineapi.com?Action=ListNamespaces&Version=2022-05-12​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
调用该 API 时,除了以下请求参数外,还需传入公共请求参数。公共请求参数说明,请参见 火山引擎公共参数文档。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ListNamespaces​
接口名称。当前 API 的名称为 ListNamespaces。​
Version​
String​
是​
2022-05-12​
接口版本。当前 API 的版本为 2022-05-12。​
Registry​
String​
是​
registrya​
指定的镜像仓库实例名称。在 镜像仓库控制台 的 实例列表页面,获取实例名称。​
Filter​
Object of NamespaceFilter​
否​
​
待查询命名空间的过滤条件。​
PageSize​
Long​
否​
10​
单页展示的命名空间数量,默认为 10 个,取值范围为 [1,100] 的整数。​
PageNumber​
Long​
否​
1​
开始显示返回结果的页码,从 1 开始,默认为 1,取值范围为 [1,2147483647] 的整数。​
​
NamespaceFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
Names​
Array of String​
否​
["ns1","ns2"]​
指定命名空间名称。在 镜像仓库控制台 目标实例的 命名空间页面,获取命名空间名称。​
支持精确匹配和模糊匹配,模糊匹配仅支持使用星号(*)作为通配符。单次最多填写 20 个命名空间名称。​
Projects​
Array of String​
否​
["projecta","projectb"]​
筛选用户所属的项目,让 inProject 为 true 时读取这个参数进行筛选​
​
请求示例​
​
POST https://cr.cn-beijing.volcengineapi.com?Action=ListNamespaces&Version=2022-05-12​
{​
"Registry": "registrya",​
"PageNumber": 1,​
"PageSize": 20,​
"Filter": {​
"Names": [​
"namespacea"​
]​
}​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Registry​
String​
registrya​
指定镜像仓库实例名称。​
TotalCount​
Long​
1​
查询到的命名空间数量。​
PageNumber​
Long​
1​
当前页码。​
PageSize​
Long​
10​
单页显示的命名空间信息条数。​
Items​
Array of Namespace​
​
命名空间列表,详情请参见 Namespace。​
​
Namespace​
​
参数​
类型​
示例值​
描述​
Name​
String​
namespacea​
命名空间名称。​
Project​
String​
projecta​
Namespace 所属项目的名称。该参数为空时,表示创建的 Namespace 不属于任何项目。​
CreateTime​
String​
2022-05-20T13:00:55Z​
创建命名空间的时间。RFC3339格式的 UTC+0 时间。​
RepositoryDefaultAccessLevel​
String​
Private​
命名空间下 OCI 制品仓库的默认公开属性。​
  • Public:公开,不需要访问密钥,支持直接访问。​
  • Private:私有,需要输入访问密钥后才能够访问。​
​
返回示例​
​
{​
"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.​
当前实例状态下不允许执行指定操作,请等待状态转换后重试。​
​
最近更新时间:2025.08.21 10:44:35
这个页面对您有帮助吗?
有用
有用
无用
无用