查询支持的镜像列表
功能介绍
根据指定条件分页查询满足条件的所有镜像。
接口约束
暂无约束
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/images
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
用户项目ID，获取方法请参见获取项目ID和名称。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
否 |
Integer |
每一页的数量，默认值200。 |
name |
否 |
String |
镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 |
name_fuzzy_match |
否 |
Boolean |
镜像名称是否模糊匹配，默认为true |
namespace |
否 |
String |
镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 |
offset |
否 |
Integer |
分页记录的起始位置偏移量，默认值0。 |
service_type |
否 |
String |
镜像支持服务类型。枚举值如下：
|
sort_dir |
否 |
String |
排序方式，ASC升序，DESC降序，默认DESC。 |
sort_key |
否 |
String |
排序的字段，多个字段使用(“,”)逗号分割。 |
type |
否 |
String |
镜像类型。枚举值如下：
|
workspace_id |
否 |
String |
工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 |
请求参数
无
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
current |
Integer |
当前页数。 |
data |
Array of ImageResponse objects |
数据。 |
pages |
Integer |
总的页数。 |
size |
Integer |
每一页的数量。 |
total |
Long |
总的记录数量。 |
参数 |
参数类型 |
描述 |
|---|---|---|
arch |
String |
该镜像所支持处理器架构类型。枚举值：
|
create_at |
Long |
镜像创建的时间，UTC毫秒。 |
description |
String |
该镜像所对应的描述信息，长度限制512个字符。 |
dev_services |
Array of strings |
镜像支持的服务。 枚举值如下:
|
id |
String |
待创建开发环境实例的镜像，需要指定镜像ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。预置镜像的ID参考查询支持的镜像列表获取。 |
name |
String |
镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 |
namespace |
String |
镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 |
origin |
String |
指定镜像来源，可选项，默认自定义构建镜像为CUSTOMIZE。 枚举值：
|
resource_categories |
Array of strings |
镜像支持的规格。 枚举值如下：
|
service_type |
String |
镜像支持服务类型。枚举值如下：
|
size |
Long |
镜像大小（单位KB）。 |
status |
String |
镜像状态。枚举值如下：
|
status_message |
String |
镜像保存操作过程中，构建信息展示。 |
swr_path |
String |
SWR镜像地址。 |
tag |
String |
镜像Tag。 |
type |
String |
镜像类型。枚举值如下：
|
update_at |
Long |
镜像最后更新的时间，UTC毫秒。 |
visibility |
String |
镜像可见度。枚举值：
|
workspace_id |
String |
工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 |
请求示例
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
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。
