查询镜像仓库列表
功能介绍
查询镜像仓库列表
接口约束
无
调用方法
请参见如何调用API。
URI
GET /v2/manage/repos
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
namespace |
否 |
String |
组织名称。小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,小数点、下划线、中划线不能直接相连),小写字母或数字结尾,1-64个字符。 |
name |
否 |
String |
镜像仓库名称。小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,小数点、斜杠、下划线、中划线不能直接相连),小写字母或数字结尾,1-128个字符。如果您的镜像名称repository参数中有斜杠,请先替换成$再进行请求。 |
category |
否 |
String |
镜像仓库分类,可设置为app_server, linux, framework_app, database, lang, other, windows, arm。 |
limit |
否 |
String |
返回条数。注意:offset和limit参数需要配套使用。如果不传该参数默认返回的条数是100。 |
offset |
否 |
String |
起始索引。 取值范围:必须为数字且大于等于0。如果不传该参数默认返回的起始索引是0。 注意:offset和limit参数需要配套使用。 |
order_column |
否 |
String |
按列排序,可设置为updated_time(按更新时间排序),name(名称)、tag_count(版本数)、namespace(组织)、is_public(是否公开私有)。注意:order_column和order_type参数需要配套使用。 |
order_type |
否 |
String |
排序类型,可设置为desc(降序)、asc(升序)。注意:order_column和order_type参数需要配套使用。 |
is_public |
否 |
String |
是否公开私有,true为公开,false为私有 |
filter |
否 |
String |
注意:至少要传递一个filter参数。 其中{namespace}为组织名称,模糊匹配。 {name}为镜像仓库名称,模糊匹配。 {category}为镜像仓库分类,可设置为app_server、linux、framework_app、database、lang、other、windows、arm。 {is_public}为镜像是否公开私有,true为公开,false为私有。 {limit}为返回条数,{offset}为起始索引,注意:offset和limit参数需要配套使用。 {order_column}为按列排序,可设置为updated_time(按更新时间排序),name(名称)、tag_count(版本数)、namespace(组织)、is_public(是否公开私有)。 {order_type}为排序类型, 可设置为desc(降序)、asc(升序),注意:order_column和order_type参数需要配套使用。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json 缺省值:application/json |
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
Content-Range |
String |
offset(开始索引)-count(当前页记录条数)/total(总记录条数) |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of ShowReposResp objects |
请求成功 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
仓库名称 |
category |
String |
仓库类型(计划改造,每个镜像会有多个label标示) |
description |
String |
仓库描述信息 |
size |
Long |
仓库大小 |
is_public |
Boolean |
仓库是否为公共仓库,值为true或false |
num_images |
Long |
仓库中镜像个数,0 ~ 9223372036854775807 |
num_download |
Long |
仓库下载次数 |
created_at |
String |
仓库创建时间,UTC日期格式,时间为UTC标准时间,用户需要根据本地时间计算偏移量;如东8区需要+8:00 |
updated_at |
String |
仓库更新时间,UTC日期格式,时间为UTC标准时间,用户需要根据本地时间计算偏移量;如东8区需要+8:00 |
logo |
String |
仓库logo地址(暂时未用) |
url |
String |
仓库logo图片的URL,URL格式。(暂时未用) |
path |
String |
镜像pull路径,格式为 swr.cn-north-1.myhuaweicloud.com/namespace/repository |
internal_path |
String |
镜像pull路径,格式为 10.125.0.198:20202/namespace/repository |
domain_name |
String |
租户名 |
namespace |
String |
租户的组织名称 |
tags |
Array of strings |
镜像版本列表 |
status |
Boolean |
查询他人共享镜像:共享是否过期 查询我共享的镜像:默认为false,无意义 |
total_range |
Long |
总记录条数 |
请求示例
GET https://{endpoint}/v2/manage/repos
响应示例
状态码: 200
请求成功
[ { "name" : "nginx", "category" : "linux", "size" : 200977474, "is_public" : false, "num_images" : 2, "num_download" : 0, "created_at" : "2017-01-01T00:00:00Z", "updated_at" : "2017-09-11T03:00:02.542841141Z", "url" : "", "path" : "swr.cn-north-1.myhuaweicloud.com/namespace/repository", "internal_path" : "10.125.0.198:20202/namespace/repository", "domain_name" : "root", "namespace" : "root", "tags" : [ "latest", "log" ], "status" : false, "total_ranage" : 4 } ]
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
错误的请求 |
401 |
鉴权失败 |
500 |
内部错误 |
错误码
请参见错误码。