查询镜像仓库列表详情(v3) - ListRepoDetails
功能介绍
查询镜像仓库列表详情
接口约束
无
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v3/manage/repos
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| namespace | 否 | String | 参数解释: 组织名称。用于唯一标识一个组织,组织下的所有镜像仓库都属于该组织。 约束限制: 不涉及。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。 默认取值: 不涉及。 |
| name | 否 | String | 参数解释: 镜像仓库名称过滤关键字,用于模糊匹配镜像仓库列表。与精确匹配的name参数不同,filter支持模糊查询。 约束限制: 不涉及。 取值范围: 小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符。 默认取值: 不涉及。 |
| category | 否 | String | 参数解释: 镜像仓库分类。用于按分类过滤镜像仓库列表。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 返回条数。用于分页查询时指定每页返回记录的数量。 约束限制: 不涉及。 取值范围: 1~1000。 默认取值: 100。 |
| marker | 否 | Integer | 参数解释: 分页查询下一次查询起始标记。用于游标分页,接口返回值中的nextMarker/next_marker为下一次查询的起始标记。 约束限制: 不涉及。 取值范围: 取值来自上次查询响应中的nextMarker字段值;首次查询不传。 默认取值: 不涉及。 |
| is_public | 否 | Boolean | 参数解释: 是否公开。用于按公开或私有属性过滤镜像仓库列表。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),用于指定请求体的MIME类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| repos | Array of ShowReposRespV3 objects | 参数解释: 镜像仓库列表,元素为ShowReposRespV3对象,每个对象表示一个镜像仓库的详细信息。 取值范围: 不涉及。 |
| nextMarker | Integer | 参数解释: 分页查询时,查询下一页数据的起始位置。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 仓库ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 仓库名称。 取值范围: 小写字母或数字开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符 |
| category | String | 参数解释: 仓库类型。 取值范围: |
| description | String | 参数解释: 仓库描述信息。 取值范围: 最大256KB或30000字符。 |
| size | Long | 参数解释: 仓库大小。 取值范围: 不涉及。 |
| is_public | Boolean | 参数解释: 仓库是否为公共仓库,值为true或false。 取值范围: |
| num_images | Long | 参数解释: 仓库中镜像个数。 取值范围: 0~10000 |
| num_download | Long | 参数解释: 仓库下载次数。 取值范围: 不涉及。 |
| created_at | String | 参数解释: 仓库创建时间,UTC日期格式,时间为UTC标准时间,用户需要根据本地时间计算偏移量;如东8区需要+8:00。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 仓库更新时间,UTC日期格式,时间为UTC标准时间,用户需要根据本地时间计算偏移量;如东8区需要+8:00。 取值范围: 不涉及。 |
| domain_name | String | 参数解释: 仓库所属租户。 取值范围: 由中文字符、英文字母、数字及「_」、「-」、「.」组成,长度1~255个字符。 |
| namespace_name | String | 参数解释: 租户的组织名称。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。 |
| status | Boolean | 参数解释: 查询他人共享镜像:共享是否过期; 查询我共享的镜像:默认为false,无意义。 取值范围: |
请求示例
GET https://{endpoint}/v3/manage/repos 响应示例
状态码:200
{
"repos" : [ {
"id" : 1,
"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",
"domain_name" : "test",
"namespace_name" : "root"
} ],
"nextMarker" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 错误的请求 |
| 401 | 鉴权失败 |
| 500 | 内部错误 |
错误码
请参见错误码。