九游平台/ ai开发平台modelarts/ / / 创建notebook实例
更新时间：2024-06-06 gmt 08:00

创建notebook实例-九游平台

功能介绍

创建开发环境实例，可以根据您指定的实例规格，不同ai引擎镜像，存储等相关参数，为您创建一个开发环境，您可以通过网页和ssh客户端访问该开发环境。 该接口为异步操作，创建开发环境实例的状态请通过查询开发环境实例详情接口获取。

接口约束

暂无约束

调试

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

uri

post /v1/{project_id}/notebooks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

string

用户项目id，获取方法请参见。

请求参数

表2 请求body参数

参数

是否必选

参数类型

描述

description

否

string

实例描述信息，长度限制为512字符，且不能包含字符&<>"'/。

duration

否

long

以当前时刻为起点，运行的时长（到期后自动停止），推荐该属性在leasereq中配置，若此处有值则忽略leasereq的值，且实例自动停止类型为定时停止。单位：毫秒。

endpoints

否

array of endpointsreq objects

本地ide（如pycharm、vs code）或ssh客户端，通过ssh远程接入notebook实例时需要的相关配置。

feature

否

string

实例类别，默认为notebook。枚举值：

  • default：codelab免费规格实例，每个用户最多只能创建一个。

  • notebook：计费规格实例。

flavor

是

string

实例的机器规格。如下规格仅供参照，实际支持规格以具体区域为准。

  • modelarts.vm.cpu.2u：intel cpu通用规格，用于快速数据探索和实验。

  • modelarts.vm.cpu.8u：intel cpu算力增强型，适用于密集计算场景下运算。

image_id

是

string

待创建开发环境实例的镜像，需要指定镜像id，id格式为通用唯一识别码（universally unique identifier，简称uuid）。镜像的id可通过调用接口获取。

name

是

string

实例名称，长度限制为128个字符，支持大小写字母、数字、中划线和下划线，名称可重复。

pool_id

否

string

专属资源池id，若需要指定专属资源池创建实例时必填，示例：pool41664192。

volume

是

volumereq object

存储配置。

workspace_id

否

string

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

hooks

否

customhooks object

自定义启动脚本钩子配置。

lease

否

leasereq object

实例租约配置。
表3 endpointsreq

参数

是否必选

参数类型

描述

allowed_access_ips

否

array of strings

允许远程接入的公网ip地址列表，最多5个。

dev_service

否

string

支持的服务，枚举值如下：

  • notebook：可以通过https协议访问notebook。

  • ssh：可以通过ssh协议远程连接notebook。

ssh_keys

否

array of strings

ssh密钥对名称，可以在云服务器控制台（ecs）“密钥对”页面创建和查看。
表4 volumereq

参数

是否必选

参数类型

描述

capacity

否

integer

存储容量，evs默认5g，最大限制4096g。

category

是

string

支持的存储类型。不同存储类型的差异，详见。枚举值如下：

  • sfs：弹性文件服务

  • evs：云硬盘

ownership

是

string

资源所属，枚举值如下：

  • managed：托管，即资源在服务上。

  • dedicated：非托管，即资源在用户账号上，只有在category为efs时支持。

uri

否

string

efs专属存储盘uri，只有当category为efs，同时ownership为dedicated时必填。 登录弹性文件服务控制台，在文件系统列表中，单击文件系统名称进入详情页。其中，“共享路径”即为此参数的参数值。

id

否

string

efs专属存储盘id，只有当category为efs，同时ownership为dedicated时必填。必填。 参数值获取方式如下：登录弹性文件服务控制台，在文件系统列表中，单击文件系统名称进入详情页。其中，“id”即为此参数的参数值。
表5 customhooks

参数

是否必选

参数类型

描述

container_hooks

否

containerhooks object

容器相关的钩子配置。
表6 containerhooks

参数

是否必选

参数类型

描述

post_start

否

config object

启动服务后脚本配置。

pre_start

否

config object

启动服务前脚本配置。
表7 config

参数

是否必选

参数类型

描述

script

否

string

自定义脚本内容（base64编码）或脚本绝对路径。

type

否

string

脚本类型：

  • command script中需要指定脚本内容（base64编码）。

  • script 默认值，script中需要指定脚本路径。
表8 leasereq

参数

是否必选

参数类型

描述

duration

否

long

定时停止，以当前时刻为起点，运行的时长（到期后自动停止）。单位：毫秒。

type

否

string

自动停止类别，默认为timing。

响应参数

状态码： 200

表9 响应body参数

参数

参数类型

描述

action_progress

array of jobprogress objects

实例初始化进度。

description

string

实例描述。

endpoints

array of endpointsres objects

本地ide（如pycharm、vs code）或ssh客户端，通过ssh远程接入notebook实例时需要的相关配置。

fail_reason

string

实例失败原因。

flavor

string

实例规格。

id

string

实例id。

image

image object

实例镜像信息。

lease

lease object

实例自动停止的倒计时信息。

name

string

实例名称。

pool

pool object

专属池的基本信息，在专属池中创建的实例会返回该字段。

status

string

实例状态。枚举值如下：

  • init：初始化

  • creating：创建中

  • starting：启动中

  • stopping：停止中

  • deleting：删除中

  • running：运行中

  • stopped：已停止

  • snapshotting：快照中(保存镜像时的状态)

  • create_failed：创建失败

  • start_failed：启动失败

  • delete_failed：删除失败

  • error：错误

  • deleted：已删除

  • frozen：冻结

token

string

notebook鉴权使用的token信息。

url

string

实例访问的url。

volume

volumeres object

实例存储信息。

workspace_id

string

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

feature

string

实例类别。枚举值：

  • default：codelab免费规格实例，每个用户最多只能创建一个。

  • notebook：计费规格实例。
表10 jobprogress

参数

参数类型

描述

notebook_id

string

实例id。

status

string

任务某个步骤的状态。枚举值如下：

  • waiting：等待中

  • processing：处理中

  • failed：任务失败

  • completed：任务完成

step

integer

任务的步骤。枚举值如下:

  • 1：准备存储

  • 2：准备计算资源

  • 3：配置网络

  • 4：初始化实例

step_description

string

任务某个步骤的描述。
表11 endpointsres

参数

参数类型

描述

allowed_access_ips

array of strings

允许通过ssh协议访问notebook的公网ip地址白名单列表，默认都可以访问。当配置指定ip后，则仅允许ip所在的客户端实现对notebook的访问。

dev_service

string

支持的服务，枚举值如下：

  • notebook：可以通过https协议访问notebook。

  • ssh：可以通过ssh协议远程连接notebook。

ssh_keys

array of strings

ssh密钥对名称列表，允许设置多个密钥对实现同时对ssh实例的访问。

service

string

支持的服务，枚举值如下：

  • notebook：可以通过https协议访问notebook。

  • ssh：可以通过ssh协议远程连接notebook。

uri

string

实例私有ip地址。
表12 image

参数

参数类型

描述

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”，存在创建并使用的工作空间，以实际取值为准。
表13 lease

参数

参数类型

描述

create_at

long

实例创建的时间，utc毫秒。

duration

long

实例运行时长，以创建时间为起点计算，即“创建时间 duration > 当前时刻”时，系统会自动停止实例。

enable

boolean

是否启用自动停止功能。

type

string

自动停止类别。

update_at

long

实例最后更新（不包括保活心跳）的时间，utc毫秒。
表14 pool

参数

参数类型

描述

id

string

专属资源池id。

name

string

专属资源池名称。
表15 volumeres

参数

参数类型

描述

capacity

integer

存储容量，evs默认5g，efs默认50g，最大限制4096g。

category

string

支持的存储类型。不同存储类型的差异，详见。枚举值如下：

  • sfs：弹性文件服务

  • evs：云硬盘

mount_path

string

存储挂载至notebook实例的目录，当前固定在/home/ma-user/work/下。

ownership

string

资源所属，枚举值如下：

  • managed：托管，即资源在服务上。

  • dedicated：非托管，即资源在用户账号上，只有在category为efs时支持。

status

string

evs扩容状态，扩容时的状态为resizing，此时实例可以正常使用。

请求示例

创建notebook实例。设置实例规格为“modelarts.vm.cpu.2u”，存储类型为“evs”，资源所属为“managed”，存储容量为50g。

{
  "name" : "notebooks_test",
  "feature" : "notebook",
  "workspace_id" : "0",
  "description" : "api-test",
  "flavor" : "modelarts.vm.cpu.2u",
  "image_id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
  "volume" : {
    "category" : "evs",
    "ownership" : "managed",
    "capacity" : 50
  }
}

响应示例

状态码： 200

ok

{
  "description" : "api-test",
  "feature" : "notebook",
  "flavor" : "modelarts.vm.cpu.2u",
  "id" : "f9937afa-4451-42db-a76b-72d624749f66",
  "image" : {
    "description" : "description",
    "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090",
    "name" : "notebook2.0-mul-kernel-cpu-cp36",
    "swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1",
    "tag" : "3.3.2-release_v1",
    "type" : "build_in"
  },
  "lease" : {
    "create_at" : 1638841744515,
    "duration" : 3600000,
    "enable" : true,
    "type" : "timing",
    "update_at" : 1638841744515
  },
  "name" : "notebooks_test",
  "status" : "creating",
  "token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022",
  "workspace_id" : "0"
}

状态码

状态码

描述

200

ok

201

created

401

unauthorized

403

forbidden

404

not found

错误码

请参见。

父主题：

相关文档

网站地图