← 返回首页
POST /api/notebook/removeNotebook

移除笔记本

需要认证 (管理员权限，检查只读模式)

接口描述

根据提供的笔记本 ID 移除（删除）一个笔记本。请注意：此操作通常是不可逆的，会导致笔记本及其包含的所有数据被删除。

此接口需要管理员权限，并且会在只读模式下受限（用户指南除外）。

请求参数

请求体为一个 JSON 对象，包含以下字段：

参数名 类型 必需 描述
notebook string 是 要移除的笔记本的 ID。
callback string 否 内部参数，用于特定场景下的回调，一般用户可忽略。

返回值

返回标准的 JSON 结构：

参数名 类型 描述
code number 返回码，0 表示成功，其他表示失败。
msg string 错误信息，成功时为空字符串。
data null 成功时，此字段通常为 null。
请求示例
返回示例

请求示例 (JSON)

{
  "notebook": "20200812220409-rng0qan"
}

成功返回示例

{
  "code": 0,
  "msg": "",
  "data": null
}

失败返回示例 (例如，笔记本ID不存在)

{
  "code": -1,
  "msg": "remove box [non-existent-id] failed: notebook [non-existent-id] not found",
  "data": null
}

失败返回示例 (只读模式)

{
  "code": -1,
  "msg": "只读模式下无法执行该操作",
  "data": {
    "closeTimeout": 5000
  }
}

注意：这是一个社区维护的文档，可能与官方最新版本存在差异。

如果您觉得本文档有帮助，可以考虑赞助支持：爱发电