查询共享镜像列表 - ListSharedReposDetails
功能介绍
查询共享镜像列表
接口约束
无
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/manage/shared-repositories
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| namespace | 否 | String | 参数解释: 组织名称。用于唯一标识一个组织,组织下的所有镜像仓库都属于该组织。 约束限制: 不涉及。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符。 默认取值: 不涉及。 |
| name | 否 | String | 参数解释: 镜像仓库名称过滤关键字,用于模糊匹配镜像仓库列表。与精确匹配的name参数不同,filter支持模糊查询。 约束限制: 不涉及。 取值范围: center::{center}|name::{name}|limit::{limit}|offset::{offset}|namespace::{namespace}|order_column::{order_column}|order_type::{order_type}, 其中{center}可选为self: 我共享的镜像。thirdparty: 他人共享给我的镜像,namespace为组织名称,name为镜像仓库名称,{limit}为返回条数,{offset}为起始索引, {order_column}为按列排序,可设置为name、updated_time、tag_count,{order_type}为排序类型,可设置为desc(降序)、asc(升序)。 默认取值: 不涉及。 |
| center | 是 | String | 参数解释: 共享类型。用于区分查询我共享的镜像还是他人共享给我的镜像。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| limit | 否 | String | 参数解释: 返回条数。用于分页查询时指定每页返回记录的数量。 约束限制: offset和limit参数需要配套使用。 取值范围: 1~100 默认取值: 不涉及。 |
| offset | 否 | String | 参数解释: 起始索引。用于分页查询时指定返回记录的起始位置。 约束限制: offset和limit参数需要配套使用。 取值范围: 大于等于0的整数 默认取值: 不涉及。 |
| order_column | 否 | String | 参数解释: 按列排序。用于指定排序字段。 约束限制: order_column和order_type参数需要配套使用。 取值范围: 默认取值: 不涉及。 |
| order_type | 否 | String | 参数解释: 排序类型。用于指定排序方向。 约束限制: order_column和order_type参数需要配套使用。 取值范围: 默认取值: 不涉及。 |
| filter | 否 | String | 参数解释: 镜像仓库名称过滤关键字,用于模糊匹配镜像仓库列表。与精确匹配的name参数不同,filter支持模糊查询。 约束限制: 不涉及。 取值范围: 小写字母或数字开头,后面跟小写字母、数字、小数点、斜杠、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),用于指定请求体的MIME类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token。用于调用API时的鉴权。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| Content-Range | String | 参数解释: 响应头的分页范围信息,用于告知客户端当前返回记录的起止位置和总记录数。 约束限制: 不涉及。 取值范围: 格式为offset(开始索引)-count(当前页记录条数)/total(总记录条数),由数字、小数点、中划线、斜杠组成,长度1~64个字符。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of ShowReposResp objects |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 仓库名称。 取值范围: 小写字母或数字开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~128个字符 |
| category | String | 参数解释: 仓库类型。 取值范围: |
| description | String | 参数解释: 仓库描述信息。 取值范围: 最大30000字符(约256KB)。 |
| 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。 取值范围: 不涉及。 |
| logo | String | 参数解释: 仓库logo地址(暂时未用)。 取值范围: 不涉及。 |
| url | String | 参数解释: 仓库logo图片的URL,URL格式。(暂时未用)。 取值范围: 不涉及。 |
| path | String | 参数解释: 镜像pull路径,格式为 swr.cn-north-1.myhuaweicloud.com/namespace/repository。 取值范围: 格式为swr.{region}.myhuaweicloud.com/{namespace}/{repository}。 |
| internal_path | String | 参数解释: 镜像pull路径,格式为 10.125.0.198:20202/namespace/repository。 取值范围: 格式为{ip}:{port}/{namespace}/{repository}。 |
| domain_name | String | 参数解释: 租户名。 取值范围: 由中文字符、英文字母、数字及「_」、「-」、「.」组成,长度1~255个字符。 |
| namespace | String | 参数解释: 租户的组织名称。 取值范围: 小写字母开头,后面跟小写字母、数字、小数点、下划线或中划线(其中下划线最多允许连续两个,不同类型分隔符不能直接相连),小写字母或数字结尾,长度1~64个字符 |
| tags | Array of strings | 参数解释: 被签名镜像版本tag列表,列表元素为被签名镜像版本的tag名称。 取值范围: 不涉及。 |
| status | Boolean | 参数解释: 查询他人共享镜像:共享是否过期; 查询我共享的镜像:默认为false,无意义。 取值范围: |
| total_range | Long | 参数解释: 总记录条数。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v2/manage/shared-repositories 响应示例
状态码:200
[ {
"name" : "huawei",
"category" : "other",
"description" : "",
"size" : 115645792,
"is_public" : false,
"num_images" : 1,
"num_download" : 0,
"created_at" : "2018-03-21T12:22:37Z",
"updated_at" : "2018-03-21T12:22:37Z",
"logo" : "",
"url" : "",
"path" : "swr.cn-north-1.myhuaweicloud.com/namespace/huawei",
"internal_path" : "100.125.0.198:20202/namespace/huawei",
"domain_name" : "domian",
"namespace" : "namespace",
"tags" : [ "latest" ],
"status" : true
} ] 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 错误的请求 |
| 401 | 鉴权失败 |
| 500 | 内部错误 |
错误码
请参见错误码。