# 获取算法镜像列表-GetAlgorithmImagesList #### 功能介绍 获取算法镜像列表。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-octopus/Permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | octopus:simAlgorithm:list | List | - | - | - | - | #### URI GET https://{hostURL}/v2/{project_id}/sim/pm/algorithm-images 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-octopus/octopus-10-0020.html)。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | algorithm | 否 | Integer | **参数解释**： 算法ID。 **约束限制**： 需要确保算法存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | algorithm_id | 否 | Integer | **参数解释**： 算法ID。 **约束限制**： 需要确保算法存在 **取值范围**： 大于0。 **默认取值**： 不涉及 | | limit | 否 | Integer | **参数解释**： 返回个数上限。 **约束限制**： 不涉及 **取值范围**： \[0-100\] **默认取值**： 10 | | offset | 否 | Integer | **参数解释**： 查询偏移量。 **约束限制**： 不涉及 **取值范围**： 大于等于0 **默认取值**： 0 | | ordering | 否 | String | **参数解释**： 查询结果的排序方式。 **约束限制**： 不涉及 **取值范围**： 默认升序，-为降序 - id： 根据id排序 - created_at： 根据创建时间排序 **默认取值**： 无 | | search | 否 | String | **参数解释**： 对算法名称进行模糊搜索。 **约束限制**： 不涉及。 **取值范围**： 只能由中文字符、英文字母、数字组成的字符。 **默认取值**： 不涉及 | | status | 否 | Integer | **参数解释**： 镜像状态。 **约束限制**： 需要确保算法存在 **取值范围**： - *0* - 推送成功 - *1* - 等待中 - *2* - 类型错误 - *3* - 不存在 - *4* - 下载失败 - *5* - 构建失败 - *32* - 未知 - *100* - 初始化 - *101* - 初始化失败 - *200* - 待推送 - *201* - 推送中 **默认取值**： 不涉及 | | type | 否 | String | **参数解释**： 镜像类型。 **约束限制**： 必须是已存在的镜像版本。 **取值范围**： - *build* - Build - *upload* - Upload **默认取值**： 不涉及 | | version | 否 | String | **参数解释**： 镜像版本。 **约束限制**： 必须是已存在的镜像版本。 **取值范围**： 纯数字字符串。 **默认取值**： 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释**： 成员总量。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | next | String | **参数解释**： 下一页结果集资源地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | previous | String | **参数解释**： 上一页结果集资源地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | results | Array of [AlgImageListSrlz] objects | **参数解释**： 当前页结果集信息。 **约束限制**： 不涉及 | 表4AlgImageListSrlz | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | **参数解释**： 算法镜像资源地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | id | Integer | **参数解释**： 算法镜像ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及 **默认取值**： 不涉及 | | created_at | Double | **参数解释**： 创建时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | updated_at | Double | **参数解释**： 更新时间。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | type | [type] object | **参数解释**： 镜像类型。 **约束限制**： 不涉及。 **取值范围**： - *build* - Build - *upload* - Upload **默认取值**： 不涉及 | | version | String | **参数解释**： 镜像版本。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | algorithm | String | **参数解释**： 绑定的算法资源地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | 表5type | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | **参数解释**： 镜像类型。 **约束限制**： 不涉及。 **取值范围**： - *build* - Build - *upload* - Upload **默认取值**： 不涉及 | #### 请求示例 获取算法镜像列表 ``` GET https://{endpoint}/v2/{project_id}/sim/pm/algorithm-images?offset=0&limit=10&algorithm=30 ``` #### 响应示例 **状态码：200** ``` { "count" : 1, "next" : null, "previous" : null, "results" : [ { "url" : "/v2/my_project_id/sim/pm/algorithm-images/25/", "id" : 25, "created_at" : 1.699954029767271E9, "updated_at" : 1.699954030498088E9, "type" : "upload", "version" : 1, "algorithm" : "/v2/my_project_id/sim/pm/algorithms/62/" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-octopus/ErrorCode.html)。