第35章 Cloudreve API v4 接口概览：路由规范、响应结构与错误码详解

第35章 API 概览

Cloudreve 服务器提供了 RESTful API 接口，可用于执行文件管理、用户管理和系统管理等操作。

除了少数特殊的重定向路由外，所有 API 路由均以 /api/v4/ 开头。

除少数特殊路由外，所有 API 路由均返回 JSON 格式的数据。HTTP 响应状态码固定为 200，具体的错误信息通过响应体中的 code 和 msg 字段返回。json{ "data": ..., // 任意类型 "code": 0, // 0 表示无错误 "msg": "" }

错误码的定义可参考 error.go 文件，以下为参考列表：

203 未完全成功 401 未登录 403 无访问权限 404 资源未找到 409 资源冲突 40001 参数错误 40002 上传失败 40003 文件夹创建失败 40004 对象已存在 40005 签名已过期 40006 当前存储策略不允许此操作 40007 该用户组不允许此操作 40008 需要管理员权限 40009 主节点未注册 40010 需要绑定手机号 40011 上传会话已过期 40012 无效的块索引 40013 无效的内容长度 40014 超出批量源大小限制 40015 超出 Aria2 最大任务数限制 40016 父目录不存在 40017 用户已被禁用 40018 用户未激活 40019 功能未启用 40020 无效的凭据 40021 用户未找到 40022 双重认证 (2FA) 代码错误 40023 登录会话不存在 40024 无法初始化 WebAuthn 40025 无效的 WebAuthn 凭据 40026 验证码错误 40027 需要刷新验证码 40028 邮件发送失败 40029 无效的临时链接 40030 临时链接已过期 40031 邮件服务商已被禁用 40032 邮箱已存在 40033 邮件已重发 40034 用户无法激活 40035 存储策略不存在 40036 无法删除默认存储策略 40037 存储策略下仍有文件 40038 存储策略已绑定用户组 40039 用户组未找到 40040 对系统组的操作无效 40041 用户组正在使用中 40042 无法更改默认用户的所属组 40043 对默认用户的操作无效 40044 文件未找到 40045 获取文件列表失败 40046 对系统节点的操作无效 40047 创建文件系统失败 40048 创建任务失败 40049 文件过大 40050 不允许的文件类型 40051 用户容量不足 40052 非法的对象名称 40053 根目录受保护 40054 同名文件正在上传 40055 元数据不匹配 40056 不支持的归档类型 40057 可用的存储策略已变更 40058 未找到分享链接 40059 无法保存自己的分享 40060 从节点无法向主节点发送回调 40061 Cloudreve 版本不匹配 40062 积分不足 40063 群组冲突 40064 用户已在当前群组中 40065 无效的礼品码 40066 账户已绑定 40067 账户已绑定到其他用户 40068 账户未关联 40069 密码错误 40070 分享预览已禁用 40071 无效的签名 40072 管理员无法购买用户组 40073 锁冲突 40074 URI 数量过多 40075 锁令牌已过期 40076 当前版本已过期 40077 实体不存在 40078 文件在回收站中 40079 达到文件数量限制 40080 密码无效 40081 批量操作未全部完成 40082 仅限所有者操作 40083 需要购买 40084 托管账户的最小 OpenID 40085 金额过小 40086 节点被存储策略使用 40087 域名未授权 40088 不允许匿名用户 40089 OAuth 令牌权限不足 40090 演示模式下已禁用 50001 数据库操作失败 50002 加密失败 50004 IO 操作失败 50005 内部配置参数错误 50006 缓存操作失败 50007 回调失败 50008 更新后端配置失败 50009 添加 CORS 策略失败 50010 节点离线 50011 查询文件元数据失败