
# 创建notebook - CreateNotebook
#### 功能介绍
创建notebook。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0100.html)。
#### URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks
表1路径参数 
| 参数                  | 是否必选 | 参数类型   | 描述                                                                                                                                                                                     |
|:---|:---|:---|:---|
| eihealth_project_id | 是    | String | **参数解释**： 空间ID，您可以从[获取空间ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0099.html)中获取。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字、中划线和下划线组成，且长度为\[1-128\]的字符。 **默认取值**： 不涉及 |
| project_id          | 是    | String | **参数解释**： 项目ID，您可以从[获取项目ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0033.html)中获取。 **约束限制**： 不涉及 **取值范围**： 只能由英文字母、数字、中划线和下划线组成，且长度为\[1-128\]的字符。 **默认取值**： 不涉及 |
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**： 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，[获取Token](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0011.html)接口响应消息头中X-Subject-Token的值即为Token。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-32768\]的字符。 **默认取值**： 不涉及 |
   
表3请求Body参数 
| 参数          | 是否必选 | 参数类型                                                                         | 描述                                                                                                             |
|:---|:---|:---|:---|
| description | 否    | String                                                                       | **参数解释**： 描述信息。 **约束限制**： 不涉及 **取值范围**： 长度为\[0-1024\]的字符。 **默认取值**： 不涉及                                        |
| storages    | 是    | Array of [NotebookStorage] objects | **参数解释**： 挂载信息。 **约束限制**： 元素长度为\[1-6\]。 **取值范围**： 不涉及 **默认取值**： 不涉及                                            |
| flavor      | 是    | [FlavorInfo] object                     | **参数解释**： notebook规格。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                                                |
| image       | 是    | [NotebookImage] object               | **参数解释**： 镜像信息。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                                                      |
| name        | 是    | String                                                                       | **参数解释**： notebook名称。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-63\]，仅支持小写字母、数字、中划线(-)，只能是小写字母开头，小写字母或数字结尾。 **默认取值**： 不涉及 |
   
 表4NotebookStorage 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                         |
|:---|:---|:---|:---|
| path       | 是    | String | **参数解释**： notebook存储路径。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-4096\]的字符。 **默认取值**： 不涉及            |
| mount_path | 否    | String | **参数解释**： 挂载路径，由于目前暂不支持自定义挂载，暂不开放。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-4096\]的字符。 **默认取值**： 不涉及 |
   
 表5FlavorInfo 
| 参数       | 是否必选 | 参数类型   | 描述                                                                                                       |
|:---|:---|:---|:---|
| cpu_type | 否    | String | **参数解释**： cpu架构类型。 **约束限制**： 不涉及 **取值范围**： - X86: X86架构 - ARM：ARM架构 **默认取值**： X86                        |
| cpu      | 是    | Float  | **参数解释**： notebook占用的cpu， 0.1核为100m，单位为"C"。 **约束限制**： 不涉及 **取值范围**： 1-128之间的浮点数。 **默认取值**： 1             |
| gpu      | 是    | Float  | **参数解释**： notebook占用的gpu，0.1为使用单卡10%，1为占满单个显卡，1+为使用多个显卡。 **约束限制**： 不涉及 **取值范围**： 0-16之间的浮点数。 **默认取值**： 0 |
| gpu_type | 是    | String | **参数解释**： gpu架构类型。 **约束限制**： 不涉及 **取值范围**： - GPU：支持GPU - Snt9：支持Snt9 **默认取值**： 不涉及                       |
| memory   | 是    | Float  | **参数解释**： notebook占用的内存，单位为"G"。 **约束限制**： 不涉及 **取值范围**： 范围\[2-512\]。 **默认取值**： 2                         |
   
 表6NotebookImage 
| 参数         | 是否必选 | 参数类型                                                   | 描述                                                                                 |
|:---|:---|:---|:---|
| image_type | 是    | String                                                 | **参数解释**： 镜像类型。 **约束限制**： 不涉及 **取值范围**： - SYSTEM：系统预置 - CUSTOMER：自定义 **默认取值**： 不涉及 |
| image_info | 是    | [ImageInfo] object | **参数解释**： 镜像信息。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                          |
   
 表7ImageInfo 
| 参数                  | 是否必选 | 参数类型   | 描述                                                                                                          |
|:---|:---|:---|:---|
| source_project_name | 否    | String | **参数解释**： 源空间名。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-128\]的字符。 **默认取值**： 不涉及                                      |
| image_name          | 否    | String | **参数解释**： 镜像名。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-128\]的字符，支持小写字母、数字、中划线(-)、下划线(_)、点(.)和斜杠(/)。 **默认取值**： 不涉及    |
| image_tag           | 否    | String | **参数解释**： 镜像tag名。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-64\]的字符，支持大小写字母、数字、中划线(-)、下划线(_)、点(.)和斜杠(/)。 **默认取值**： 不涉及 |
| profile             | 否    | String | **参数解释**： 系统镜像名。 **约束限制**： 不涉及 **取值范围**： 仅支持PY3 **默认取值**： 不涉及                                               |
   
#### 响应参数
**状态码：201**
表8响应Body参数 
| 参数 | 参数类型   | 描述                                                               |
|:---|:---|:---|
| id | String | **参数解释**： notebook ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 |
   
#### 请求示例
创建notebook，使用系统默认镜像，需要cpu资源1C，内存资源5G。
```
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/notebooks
{
  "flavor" : {
    "cpu" : 1,
    "cpu_type" : "X86",
    "gpu" : 0,
    "gpu_type" : "GPU",
    "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 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ai4sservice/ErrorCode.html)。
