文档首页/ AI开发平台ModelArts/ API参考/ 开发环境管理/ 通过运行的实例保存成容器镜像
更新时间:2024-05-30 GMT+08:00

通过运行的实例保存成容器镜像

功能介绍

运行的实例可以保存成容器镜像,保存的镜像中,安装的依赖包(pip包)不丢失,VS Code远程开发场景下,在Server端安装的插件不丢失。

接口约束

暂无约束

调试

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

URI

POST /v1/{project_id}/notebooks/{id}/create-image

表1 路径参数

参数

是否必选

参数类型

描述

id

String

Notebook实例ID。

project_id

String

用户项目ID,获取方法请参见获取项目ID和名称

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

description

String

该镜像所对应的描述信息,长度限制512个字符。

name

String

镜像名称,长度限制512个字符,支持小写字母、数字、中划线、下划线和点。

namespace

String

镜像所属组织,可以在SWR控制台“组织管理”创建和查看。

tag

String

镜像tag,长度限制64个字符,支持大小写字母、数字、中划线、下划线和点。

workspace_id

String

工作空间ID。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

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

待创建开发环境实例的镜像,需要指定镜像ID,ID格式为通用唯一识别码(Universally Unique Identifier,简称UUID)。预置镜像的ID参考查询支持的镜像列表获取。

name

String

镜像名称,长度限制512个字符,支持小写字母、数字、中划线、下划线和点。

namespace

String

镜像所属组织,可以在SWR控制台“组织管理”创建和查看。

origin

String

指定镜像来源,可选项,默认自定义构建镜像为CUSTOMIZE。枚举值如下:

  • CUSTOMIZE:用户自定义构建镜像。

  • IMAGE_SAVE:开发环境实例保存镜像。

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

镜像保存操作过程中,构建信息展示。

support_res_categories

Array of strings

镜像支持的规格。 枚举值如下:

  • CPU

  • GPU

  • ASCEND

swr_path

String

SWR镜像地址。

tag

String

镜像Tag。

type

String

镜像类型。枚举值如下:

  • BUILD_IN:系统内置镜像。

  • DEDICATED:用户保存的镜像。

update_at

Long

镜像最后更新的时间,UTC毫秒。

visibility

String

镜像可见度。枚举值如下:

  • PRIVATE:私有镜像。

  • PUBLIC: 所有用户可以根据ImageId来进行只读使用。

workspace_id

String

工作空间ID。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。

请求示例

将运行的实例可以保存成容器镜像。设置镜像名称为“pytorch1_4”,镜像所属组织为“atelier-auto”。

{
  "name" : "pytorch1_4",
  "namespace" : "atelier-auto",
  "tag" : "20221223",
  "description" : "save from notebook-x21d",
  "workspace_id" : "0"
}

响应示例

状态码: 200

OK

{
  "arch" : "x86_64",
  "create_at" : 1671786468811,
  "description" : "notebook2.0 20200816",
  "dev_services" : [ "SSH", "NOTEBOOK" ],
  "id" : "4e0d1854-63e5-4517-b683-a0ee97a692a1",
  "name" : "pytorch1_4",
  "namespace" : "atelier-auto",
  "origin" : "IMAGE_SAVE",
  "resource_categories" : [ "CPU", "GPU" ],
  "service_type" : "TRAIN",
  "status" : "INIT",
  "swr_path" : "swr.xxxxx.com/atelier-auto/pytorch1_4:20221223",
  "tag" : "20221223",
  "type" : "DEDICATED",
  "update_at" : 1671786468811,
  "visibility" : "PRIVATE",
  "workspace_id" : "0"
}

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码