创建notebook
功能介绍
创建notebook
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| eihealth_project_id | 是 | String | 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 |
| project_id | 是 | String | 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| description | 否 | String | 描述信息,取值范围[0,1024] 最小长度:0 最大长度:1024 |
| storages | 是 | Array of NotebookStorage objects | 挂载信息 数组长度:1 - 6 |
| flavor | 是 | FlavorInfo object | notebook规格 |
| image | 是 | NotebookImage object | 镜像信息 |
| name | 是 | String | notebook名称,取值范围[1,63],仅支持小写字母、数字、中划线(-),开始只能是小写字母,结束只能是小写字母或数字 最小长度:1 最大长度:63 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| path | 是 | String | notebook存储路径 最小长度:1 最大长度:4096 |
| mount_path | 否 | String | 挂载路径,由于目前暂不支持自定义挂载,暂不开放 最小长度:1 最大长度:4096 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cpu | 是 | Float | notebook占用的cpu,0.1核为100m,单位为"C" 最小值:1 最大值:128 缺省值:1 |
| gpu | 是 | Float | notebook占用的gpu,0.1为使用单卡10%,1为占满单个显卡,1+为使用多个显卡 最小值:0 最大值:16 缺省值:0 |
| memory | 是 | Float | notebook占用的内存,单位为"G" 最小值:2 最大值:512 缺省值:2 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| image_type | 是 | String | 镜像类型 枚举值:
|
| image_info | 是 | ImageInfo object | 镜像信息 |
响应参数
状态码: 201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | notebook ID |
请求示例
创建notebook,使用系统默认镜像,需要cpu资源1C,内存资源5G。
https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks
{
"flavor" : {
"cpu" : 1,
"gpu" : 0,
"memory" : 5
},
"image" : {
"image_type" : "SYSTEM",
"image_info" : {
"profile" : "PY3"
}
},
"storages" : [ {
"path" : "OBSFS:test-bucket:/"
} ],
"name" : "test-notebook",
"description" : "test"
} 响应示例
状态码: 201
CREATED
{
"id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda"
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | CREATED |
错误码
请参见错误码。