关闭指定的笔记本。此操作会从当前工作空间卸载该笔记本,但不会删除笔记本的物理文件。
此接口会调用内核的 model.Unmount
方法来实际执行操作。
此接口需要管理员权限,并且会在只读模式下受限。
请求体为一个 JSON 对象,包含以下字段:
参数名 | 类型 | 必需 | 描述 |
---|---|---|---|
notebook | string | 是 | 要关闭的笔记本的 ID。 |
返回标准的 JSON 结构:
参数名 | 类型 | 描述 |
---|---|---|
code | number | 返回码,0 表示成功,其他表示失败。 |
msg | string | 错误信息,成功时为空字符串。 |
data | null | 成功时,此字段为 null。如果笔记本 ID 无效或解析参数失败,也可能返回 null,此时应检查 code 和 msg。 |
{
"notebook": "20200812220409-rng0qan"
}
{
"code": 0,
"msg": "",
"data": null
}
{
"code": -1,
"msg": "Invalid notebook ID pattern: NotebookID_Pattern_Error_Message_Here / Or readonly mode message",
"data": null
}