查询支持的镜像列表 - ListImage

功能介绍

查询支持的镜像列表接口用于根据指定条件分页查询满足条件的所有镜像。该接口适用于以下场景：当用户需要查找特定镜像、管理镜像仓库或选择合适的镜像版本进行部署时，可通过此接口获取符合条件的镜像列表。使用该接口的前提条件是镜像仓库已存在且用户具有访问权限。查询操作完成后，将返回满足条件的镜像列表，包括镜像ID、名称、版本、类型、状态、大小和创建时间等详细信息。若镜像仓库不存在、用户无权限访问或查询条件有误，接口将返回相应的错误信息。

接口约束

暂无约束。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:image:list
List
image *
-
-
-
-
g:EnterpriseProjectId

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
modelarts:image:list	List	image *	-	-	-
-	g:EnterpriseProjectId

URI

GET /v1/{project_id}/images

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

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释：每一页显示的镜像实例数量。约束限制：不涉及。取值范围：正整数。默认取值：200。
name	否	String	参数解释：镜像名称。约束限制：不涉及。取值范围：长度限制为512个字符，支持小写字母、数字、中划线、下划线和点。默认取值：不涉及。
name_fuzzy_match	否	Boolean	参数解释：镜像名称是否模糊匹配查询。约束限制：不涉及。取值范围：布尔类型： true：支持模糊匹配查询。 false：不支持模糊匹配查询。默认取值：true。
namespace	否	String	参数解释：镜像所属组织，可以在SWR控制台“组织管理”创建和查看。约束限制：不涉及。取值范围：长度限制为64个字符，支持大小写字母、数字、中划线、下划线和点号，且必须是小写字母开头。默认取值：不涉及。
offset	否	Integer	参数解释：分页记录的起始位置偏移量。约束限制：不涉及。取值范围：非负整数。默认取值：0。
service_type	否	String	参数解释：镜像支持服务类型。约束限制：不涉及。取值范围：枚举类型，取值如下： COMMON：通用镜像。 INFERENCE: 建议仅在推理部署场景使用。 TRAIN: 建议仅在训练任务场景使用。 DEV: 建议仅在开发调测场景使用。 UNKNOWN: 未明确设置的镜像支持的服务类型。默认取值：UNKNOWN。
sort_dir	否	String	参数解释：实例排序方式。约束限制：不涉及。取值范围：枚举类型，取值如下： ASC：升序 DESC：降序默认取值：DESC。
sort_key	否	String	参数解释：排序的字段，多个字段使用(“,”)逗号分隔。约束限制：不涉及。取值范围：长度限制为128个字符，支持大小写字母、数字、中划线、下划线和逗号。默认取值：不涉及。
type	否	String	参数解释：镜像类型。约束限制：不涉及。取值范围：枚举类型，取值如下： BUILD_IN：系统内置镜像。 DEDICATED：用户保存的镜像。默认取值：BUILD_IN。
workspace_id	否	String	参数解释：工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。约束限制：不涉及。取值范围：0或32位仅包含字符0-9或小写字母a-z的字符串。默认取值：0。
show_name	否	String	参数解释：镜像展示name。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
show_tag	否	String	参数解释：镜像展示Tag。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
current	Integer	参数解释：当前页数。取值范围：正整数。
data	Array of ImageResponse objects	参数解释：符合条件的镜像数据。
pages	Integer	参数解释：总的页数。取值范围：正整数。
size	Integer	参数解释：每一页的数量。取值范围：正整数。
total	Long	参数解释：总的记录数量。取值范围：非负整数。

表4 ImageResponse
参数	参数类型	描述
arch	String	参数解释：该镜像所支持处理器架构类型。取值范围：枚举类型，取值如下： X86_64：x86处理器架构。 AARCH64：ARM体系架构。
create_at	Long	参数解释：镜像创建的时间，UTC毫秒。取值范围：不涉及。
description	String	参数解释：该镜像所对应的描述信息，长度限制512个字符。取值范围：不涉及。
dev_services	Array of strings	参数解释：镜像支持的服务。元素为枚举类型，取值如下： NOTEBOOK：镜像支持通过https协议访问Notebook。 SSH：镜像支持本地IDE通过SSH协议远程连接Notebook。
id	String	参数解释：待创建Notebook实例的镜像，需要指定镜像ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。预置镜像的ID参考查询支持的镜像列表获取。取值范围：不涉及。
name	String	参数解释：镜像名称。取值范围：长度限制512个字符，支持小写字母、数字、中划线、下划线和点。
namespace	String	参数解释：镜像所属组织，可以在SWR控制台“组织管理”创建和查看。取值范围：不涉及。
origin	String	参数解释：指定镜像来源。取值范围：枚举类型，取值如下： CUSTOMIZE: 用户自定义构建镜像。 IMAGE_SAVE：Notebook实例保存镜像。
resource_categories	Array of strings	参数解释：镜像支持的规格。元素为枚举类型，取值如下： CPU GPU ASCEND
service_type	String	参数解释：镜像支持服务类型。取值范围：枚举类型，取值如下： COMMON：通用镜像。 INFERENCE: 建议仅在推理部署场景使用。 TRAIN: 建议仅在训练任务场景使用。 DEV: 建议仅在开发调测场景使用。 UNKNOWN: 未明确设置的镜像支持的服务类型。
size	Long	参数解释：镜像大小（单位KB）。取值范围：不涉及。
status	String	参数解释：镜像状态。取值范围：枚举类型，取值如下： INIT：初始化。 CREATING：镜像保存中，此时Notebook不可用。 CREATE_FAILED：镜像保存失败。 ERROR：错误。 DELETED：已删除。 ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建Notebook实例。
status_message	String	参数解释：镜像保存操作过程中，构建信息展示。取值范围：不涉及。
swr_path	String	参数解释：SWR镜像地址。取值范围：不涉及。
tag	String	参数解释：镜像Tag。取值范围：不涉及。
type	String	参数解释：镜像类型。取值范围：枚举类型，取值如下： BUILD_IN：系统内置镜像。 DEDICATED：用户保存的镜像。
update_at	Long	参数解释：镜像最后更新的时间，UTC毫秒。取值范围：不涉及。
visibility	String	参数解释：镜像可见度。取值范围：枚举类型，取值如下： PRIVATE：私有镜像。 PUBLIC: 所有用户可以根据image_id来进行只读使用。
workspace_id	String	参数解释：工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。取值范围：不涉及。
flavor_type	String	参数解释：镜像的资源类型。取值范围：枚举类型，取值如下： -ASCEND_SNT9：昇腾910芯片。 -ASCEND_SNT9B：昇腾910B芯片。 -ASCEND_SNT3：昇腾310芯片。
swr_instance_id	String	参数解释：企业版SWR仓库ID。取值范围：不涉及。
show_tag	String	参数解释：镜像展示Tag。取值范围：不涉及。
show_name	String	参数解释：镜像展示name。取值范围：不涉及。

状态码：401

表5 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

状态码：403

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

状态码：404

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

请求示例

GET https://{endpoint}/v1/{project_id}/images

响应示例

状态码：200

OK。

{
  "current" : 4,
  "data" : [ {
    "arch" : "x86_64",
    "create_at" : 1638841805439,
    "description" : "AI inference application development, preconfigured ModelBox and AI engine LibTorch, only SSH connection supported.",
    "dev_services" : [ "AI_FLOW", "SSH" ],
    "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54103",
    "name" : "modelbox1.3.0-libtorch1.9.1-cuda10.2-cudnn8-euler2.9.6",
    "resource_categories" : [ "GPU" ],
    "service_type" : "TRAIN",
    "status" : "ACTIVE",
    "swr_path" : "swr.xxx.com/atelier/modelarts-modelbox-libtorch-gpu-x86:1.3.0-20221027202714-160a680",
    "tag" : "1.3.0-20221027202714-160a680",
    "type" : "BUILD_IN",
    "update_at" : 1638234504492,
    "workspace_id" : "0"
  }, {
    "arch" : "x86_64",
    "create_at" : 1638841805439,
    "description" : "CPU and GPU general algorithm development and training, preconfigured with AI engine PyTorch1.8",
    "dev_services" : [ "NOTEBOOK", "SSH" ],
    "id" : "278e88d1-5b71-4766-8502-b3ba72e824d9",
    "name" : "pytorch1.8-cuda10.2-cudnn7-ubuntu18.04",
    "resource_categories" : [ "GPU", "CPU" ],
    "service_type" : "COMMON",
    "status" : "ACTIVE",
    "swr_path" : "swr.xxx.com/atelier/pytorch_1_8:pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e",
    "tag" : "pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e",
    "type" : "BUILD_IN",
    "update_at" : 1638234504492,
    "workspace_id" : "0"
  } ],
  "pages" : 54,
  "size" : 2,
  "total" : 107
}