更新时间:2022-05-27 GMT+08:00
分享

创建Notebook实例

功能介绍

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

接口约束

暂无约束

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/notebooks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

description

String

实例描述信息,长度限制为512字符,不可包含特殊字符&<>"'/,缺省值为空。

duration

Long

以当前时刻为起点,运行的时长(到期后自动停止)。单位:毫秒。

endpoints

Array of EndpointsReq objects

本地IDE(如pycharm、vsCode)或SSH客户端,通过SSH远程接入Notebook实例时需要的相关配置。

feature

String

实例类别,默认为NOTEBOOK。枚举值:

  • DEFAULT:CodeLab免费规格实例,每个用户最多只能创建一个。

  • NOTEBOOK:计费规格实例。

flavor

String

实例的机器规格。现在支持的有:

  • modelarts.vm.cpu.2u:Intel CPU通用规格,用于快速数据探索和实验。

  • modelarts.vm.cpu.8u:Intel CPU算力增强型,适用于密集计算场景下运算。

  • modelarts.bm.gpu.v100NV32:NVIDIA V100 GPU单卡规格,32GB显存,适合深度学习场景下的算法训练和调测。

  • modelarts.bm.d910.xlarge.1:昇腾910(32GB显存)单卡规格,配搭ARM处理器,适合深度学习场景下的模型训练和调测。

  • modelarts.bm.d910.xlarge.2:昇腾910(32GB显存)两卡规格,配搭ARM处理器,适合深度学习场景下的模型训练和调测。

  • modelarts.bm.d910.xlarge.8:昇腾910(32GB显存)八卡规格,配搭ARM处理器,适合深度学习场景下的模型训练和调测。

以上规格仅供参照,实际支持规格以具体区域为准。

image_id

String

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

name

String

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

pool_id

String

专属资源池ID,若需要指定专属资源池创建实例时必填,示例:pool41664192。

volume

VolumeReq object

存储配置。

workspace_id

String

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

表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,EFS默认50G,最大限制4096G。

category

String

支持的存储类型,枚举值如下:

  • EFS:默认存储,即弹性文件服务

  • EVS:云硬盘

关于这两种存储的差异,详见开发环境中如何选择存储

ownership

String

资源所属,枚举值如下:

  • MANAGED:托管,即资源在服务上。

  • DEDICATED:非托管,即资源在用户帐号上,只有在category为EFS时支持。

uri

String

EFS专属存储盘uri,只有当category为EFS,同时ownership为DEDICATED时必填。示例:192.168.0.1:/user-9sfdsdgdfgh5ea4d56871e75d6966aa274/mount/。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

action_progress

Array of JobProgress objects

实例初始化进度。

description

String

实例描述。

endpoints

Array of EndpointsRes objects

本地IDE(如pycharm、vsCode)或SSH客户端,通过SSH远程接入Notebook实例时需要的相关配置。

fail_reason

String

实例失败原因。

feature

String

实例类别。枚举值:

  • DEFAULT:CodeLab免费规格实例,每个用户最多只能创建一个。

  • NOTEBOOK:计费规格实例。

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

表6 JobProgress

参数

参数类型

描述

notebook_id

String

实例ID。

status

String

任务某个步骤的状态。枚举值:

  • WAITING:等待中

  • PROCESSING:处理中

  • FAILED:任务失败

  • COMPLETED:任务完成

step

Integer

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

  • 1:准备存储

  • 2:准备计算资源

  • 3:配置网络

  • 4:初始化实例

step_description

String

任务某个步骤的描述。

表7 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实例的访问。

表8 Image

参数

参数类型

描述

id

String

镜像ID。

name

String

镜像名称。

swr_path

String

SWR镜像地址。

type

String

镜像类型。枚举值如下:

  • BUILD_IN:系统内置镜像。

  • DEDICATED:用户保存的镜像。

表9 Lease

参数

参数类型

描述

create_time

Long

实例创建的时间,UTC毫秒。

duration

Long

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

enable

Boolean

是否启用自动停止功能。

update_time

Long

实例最后更新(不包括保活心跳)的时间,UTC毫秒。

表10 Pool

参数

参数类型

描述

id

String

专属资源池ID。

name

String

专属资源池名称。

表11 VolumeRes

参数

参数类型

描述

capacity

Integer

存储容量,EVS默认5G,EFS默认50G,最大限制4096G。

category

String

支持的存储类型,枚举值如下:

  • EFS:默认存储,即弹性文件服务

  • EVS:云硬盘

关于这两种存储的差异,详见开发环境中如何选择存储

mount_path

String

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

ownership

String

资源所属,枚举值如下:

  • MANAGED:托管,即资源在服务上。

  • DEDICATED:非托管,即资源在用户帐号上,只有在category为EFS时支持。

status

String

EVS扩容状态,扩容时的状态为RESIZING,此时实例可以正常使用。

请求示例

{
  "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" : "efs",
    "ownership" : "managed",
    "capacity" : 50
  }
}

响应示例

状态码: 200

OK

{
  "action_progress" : [ {
    "step" : 1,
    "status" : "WAITING",
    "description" : "Prepare the storage."
  }, {
    "step" : 2,
    "status" : "WAITING",
    "description" : "Prepare the compute resource."
  }, {
    "step" : 3,
    "status" : "WAITING",
    "description" : "Configuring the network."
  }, {
    "step" : 4,
    "status" : "WAITING",
    "description" : "Initialize the notebook instance."
  } ],
  "create_at" : 1638841744521,
  "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.cn-north-7.myhuaweicloud.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,
    "update_at" : 1638841744515
  },
  "name" : "notebooks_test",
  "status" : "CREATING",
  "token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022",
  "update_at" : 1638841744522,
  "workspace_id" : "0"
}

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

分享:

    相关文档

    相关产品

close