通过运行的实例保存成容器镜像
功能介绍
运行的实例可以保存成容器镜像,保存的镜像中,安装的依赖包(pip包)不丢失,VS Code远程开发场景下,在Server端安装的插件不丢失。
接口约束
暂无约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/notebooks/{id}/create-image
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
Notebook实例ID,可通过调用查询Notebook实例列表接口获取。 |
project_id |
是 |
String |
用户项目ID,获取方法请参见获取项目ID和名称。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
该镜像所对应的描述信息,长度限制512个字符。 |
name |
否 |
String |
镜像名称,长度限制512个字符,支持小写字母、数字、中划线、下划线和点。 |
namespace |
否 |
String |
镜像所属组织,可以在SWR控制台“组织管理”创建和查看。 |
tag |
否 |
String |
镜像tag,长度限制64个字符,支持大小写字母、数字、中划线、下划线和点。 |
workspace_id |
否 |
String |
工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
arch |
String |
该镜像所支持处理器架构类型。枚举值如下:
|
create_at |
Long |
镜像创建的时间,UTC毫秒。 |
description |
String |
该镜像所对应的描述信息,长度限制512个字符。 |
dev_services |
Array of strings |
镜像支持的服务。枚举值如下:
|
id |
String |
待创建Notebook实例的镜像,需要指定镜像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 |
镜像保存操作过程中,构建信息展示。 |
support_res_categories |
Array of strings |
镜像支持的规格。 枚举值如下:
|
swr_path |
String |
SWR镜像地址。 |
tag |
String |
镜像Tag。 |
type |
String |
镜像类型。枚举值如下:
|
update_at |
Long |
镜像最后更新的时间,UTC毫秒。 |
visibility |
String |
镜像可见度。枚举值如下:
|
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 |
错误码
请参见错误码。