查询镜像列表-ListImages

功能介绍

查询支持的镜像列表接口用于根据指定条件分页查询满足条件的所有镜像(不包含私有镜像)。

该接口适用于以下场景：当用户需要查找特定镜像或选择合适的镜像版本进行部署时，可通过此接口获取符合条件的镜像列表。

使用该接口的前提条件是镜像仓库已存在且用户具有访问权限。查询操作完成后，将返回满足条件的镜像列表，包括IMS镜像ID、名称、架构、状态等。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
aics::listImages	List	-	-	-	-

URI

GET /v2/{project_id}/images

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目ID，获取方法请参见获取项目ID。约束限制: 不涉及。取值范围: 不涉及。默认取值: 不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释: 分页查询单页记录数量。约束限制: 不涉及。取值范围: 1~100。默认取值: 20。
marker	否	String	参数解释: 分页标记，本次请求获取该标记后的资源，base64编码。约束限制: 不涉及。取值范围: 不涉及。默认取值: 不涉及。
name	否	String	参数解释: 镜像名称。约束限制: 不涉及。取值范围: 长度1-128，支持中英文、数字及"""-""."，满足'^(?! )(?!.? $)[a-zA-Z0-9.-\u4e00-\u9fa5 ]{1,128}$'。默认取值*: 不涉及。
arch	否	String	参数解释: 镜像架构类型。约束限制: 不涉及。取值范围: X86：X86架构。 ARM：ARM架构。默认取值: 不涉及。
hypernode_type_id	否	String	参数解释: 超节点规格ID。约束限制: 不涉及。取值范围: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。默认取值: 不涉及。
status	否	String	参数解释: 镜像状态。约束限制: 不涉及。取值范围: ACTIVE：镜像可用。 INACTIVE：镜像不可用。默认取值: 不涉及。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	参数解释: 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制: 不涉及。取值范围: 不涉及。默认取值: 不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
page_info	PageInfo object	参数解释: 分页信息。取值范围: 不涉及。
images	Array of Image objects	参数解释 : 镜像列表取值范围 : 不涉及。

表5 PageInfo
参数	参数类型	描述
next_marker	String	参数解释: 以单页最后一条资源标识作为分页标记，base64编码。用于请求下一页使用的分页标记。取值范围: 不涉及。
current_count	Integer	参数解释 : 当前查询结果数量。取值范围 : 不涉及。

表6 Image
参数	参数类型	描述
image_id	String	参数解释 : IMS镜像ID。取值范围 : UUID格式，[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。
name	String	参数解释: 镜像名称。取值范围: 长度1-128，支持中英文、数字及"""-""."，满足'^(?! )(?!.? $)[a-zA-Z0-9*.-\u4e00-\u9fa5 ]{1,128}$'。
arch	String	参数解释: 镜像架构类型。取值范围: X86：X86架构。 ARM：ARM架构。
status	String	参数解释: 镜像状态。取值范围: ACTIVE：镜像可用。 INACTIVE：镜像不可用。

请求示例

查询镜像列表请求示例。使用场景：用户需要查询指定条件的所有镜像列表时，通过设置过滤条件查询镜像。

GET https://{endpoint}/v2/{project_id}/images?name=HCE3.0-Arm-CANN8.1.RC2-v3

响应示例

状态码：200

查询成功

{
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  },
  "images" : [ {
    "image_id" : "4771d482-ac26-4a67-846f-bfb2ffeed4ff",
    "name" : "HCE3.0-Arm-CANN8.1.RC2-v3",
    "arch" : "ARM",
    "status" : "ACTIVE"
  } ]
}

状态码

状态码	描述
200	查询成功

错误码

请参见错误码。

父主题： 系统镜像

上一篇：系统镜像

下一篇：超节点资源标签