# 获取镜像仓库列表-GetImageRepoList #### 功能介绍 获取镜像仓库列表 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-octopus/Permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | octopus:imageRepo:list | List | workspace \* | - | - | - | #### URI GET /v1.0/{project_id}/common/image-registry/image-repos 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-octopus/octopus-10-0020.html)。 **约束限制**： 不涉及 **取值范围**： 只能用小写字母 a-z 和数字 0-9组成，且长度为32个字符 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | scope | 否 | String | **参数解释**： 用途 **约束限制**： 不涉及 **取值范围**： - DATA_CONVERSION：数据转换 - ANNOTATION_AI：预标注 - ANNOTATION_INSPECTION：预审核 - TRAINING_TRAIN：训练/评测 - TRAINING_COMPILE：模型编译 - TRAINING_DEV：开发环境 - TRAINING_NOTEBOOK：Notebook - SIMULATION_ALGORITHM：仿真算法 - SIMULATION_EVALUATION：仿真评测 - SIMULATION_SIMULATOR：仿真器 - SIMULATION_TESTCASE：测试用例 - COMMON_DATASET：数据集 **默认取值**： 不涉及 | | name | 否 | String | **参数解释**： 名称模糊搜索 **约束限制**： 不涉及 **取值范围**： 只能用中文字符、大小写英文字母、数字、"_"、"-"组成，且长度为\[1\~64\]个字符 **默认取值**： 不涉及 | | status | 否 | String | **参数解释**： 版本状态筛选。例：如果设置status=PUSHED，则接口只返回至少包含一个状态为"创建成功"的版本的镜像仓库，且其version_num字段的值为仓库中状态为"创建成功"的版本数量。 **约束限制**： 不涉及 **取值范围**： - INIT：初始化 - PUSHED：创建成功 - PUSHING：推送中 - SECONDARY_PUSHING：二次推送中 - PUSH_FAILED：创建失败 **默认取值**： 不涉及 | | limit | 否 | Integer | **参数解释**： 返回个数上限 **约束限制**： 与offset配合使用 **取值范围**： 最小值为1，最大值为100 **默认取值**： 10 | | offset | 否 | Integer | **参数解释**： 查询偏移量 **约束限制**： 与limit配合使用 **取值范围**： 最小值为0 **默认取值**： 0 | | visibility | 否 | String | **参数解释**： 使用范围 **约束限制**： 不涉及 **取值范围**： - TEAM：团队 - PUBLIC：公开 **默认取值**： 不涉及 | | workspace_id | 否 | String | **参数解释**： 工作空间id **约束限制**： 不涉及 **取值范围**： 小写带横杠UUID或小写无横杠UUID或单个0 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释**： 内容类型。填application/json **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | X-Auth-Token | 是 | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | payload | [RepoListPayload] object | **参数解释**： 实际返回信息 | | meta_info | [MetaInfo] object | **参数解释**： 元数据 | 表5RepoListPayload | 参数 | 参数类型 | 描述 | |:---|:---|:---| | list | Array of [ImageRepo] objects | **参数解释**： 镜像仓库列表 | | page_info | [PageInfo] object | **参数解释**： 分页信息 | 表6ImageRepo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | **参数解释**： id **取值范围**： 不涉及 | | name | String | **参数解释**： 名称 **取值范围**： 不涉及 | | description | String | **参数解释**： 描述。若镜像没有描述则不返回该字段 **取值范围**： 不涉及 | | create_at | Long | **参数解释**： 创建时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | update_at | Long | **参数解释**： 最近更新时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 | | project_id | String | **参数解释**： 项目id **取值范围**： 不涉及 | | user_id | String | **参数解释**： 创建者id **取值范围**： 不涉及 | | scope | String | **参数解释**： 用途 **取值范围**： 不涉及 | | visibility | String | **参数解释**： 使用范围 **取值范围**： 不涉及 | | version_num | Integer | **参数解释**： 版本数 **取值范围**： 不涉及 | | workspace_id | String | **参数解释**： 工作空间id **取值范围**： 不涉及 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**： 资源总数 **取值范围**： 不涉及 | | offset | Integer | **参数解释**： 查询偏移量 **取值范围**： 不涉及 | | limit | Integer | **参数解释**： 返回个数上限 **取值范围**： 不涉及 | 表8MetaInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current_time | String | **参数解释**： 请求时间，UTC时间格式，时间为UTC标准时间 **取值范围**： 不涉及 | #### 请求示例 查询镜像仓库列表 ``` GET https://{endpoint}/v1.0/{project_id}/common/image-registry/image-repos?offset=0&limit=1 ``` #### 响应示例 无 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | | 400 | 参数校验失败 | | 401 | 身份认证失败 | | 403 | 权限校验失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-octopus/ErrorCode.html)。