本文档按当前路由文件整理接口清单。所有路径默认带 /api/v1 前缀。
除健康检查、注册、登录、验证码、邮箱验证码、密码重置、刷新 Token 外，业务接口通常需要认证：
Authorization: Bearer <JWT>
JSON 响应格式：
{
"code": 0,
"msg": "成功",
"data": {}
}
| 方法 |
路径 |
说明 |
| GET |
/health |
服务存活检查 |
| 方法 |
路径 |
说明 |
| POST |
/auth/register |
用户注册 |
| POST |
/auth/login |
用户登录 |
| POST |
/auth/logout |
用户登出 |
| POST |
/auth/email/code |
发送邮箱验证码 |
| POST |
/auth/password/reset |
忘记密码或重置密码 |
| POST |
/auth/refresh |
刷新 Token |
| GET |
/auth/captcha |
获取图形验证码 |
| 方法 |
路径 |
说明 |
| GET |
/user/profile |
获取个人信息 |
| PUT |
/user/profile |
更新个人信息 |
| PUT |
/user/password |
修改密码 |
| GET |
/user/list |
用户列表 |
| GET |
/user/by-username |
按用户名查询用户 |
| POST |
/user/avatar |
上传头像 |
| GET |
/user/menu-permission |
获取当前用户菜单和权限 |
| 方法 |
路径 |
说明 |
| POST |
/admin/users |
创建用户 |
| DELETE |
/admin/users/:id |
删除用户 |
| PUT |
/admin/users/:id |
更新用户 |
| GET |
/admin/users/:id |
获取用户详情 |
| GET |
/admin/users |
管理员用户列表 |
| GET |
/admin/roles/simple |
获取角色简表 |
| GET |
/admin/restart |
重启远程服务器 |
| GET |
/admin/shutdown |
关闭远程服务器 |
| 方法 |
路径 |
说明 |
| GET |
/permissionManage/API/page |
API 权限分页 |
| GET |
/permissionManage/API/:id |
API 权限详情 |
| POST |
/permissionManage/API |
创建 API 权限 |
| PUT |
/permissionManage/API |
更新 API 权限 |
| DELETE |
/permissionManage/API/:id |
删除 API 权限 |
| DELETE |
/permissionManage/API/batch |
批量删除 API 权限 |
| 方法 |
路径 |
说明 |
| GET |
/permissionManage/menus/page |
菜单分页 |
| GET |
/permissionManage/menus/:id |
菜单详情 |
| POST |
/permissionManage/menus |
创建菜单 |
| PUT |
/permissionManage/menus |
更新菜单 |
| DELETE |
/permissionManage/menus/:id |
删除菜单 |
| DELETE |
/permissionManage/menus/batch |
批量删除菜单 |
| 方法 |
路径 |
说明 |
| GET |
/permissionManage/roles/page |
角色分页 |
| GET |
/permissionManage/roles/:id |
角色详情 |
| POST |
/permissionManage/roles |
创建角色 |
| PUT |
/permissionManage/roles |
更新角色 |
| DELETE |
/permissionManage/roles/:id |
删除角色 |
| DELETE |
/permissionManage/roles/batch |
批量删除角色 |
| GET |
/permissionManage/roles/role_perm/:id |
获取角色权限 |
| PUT |
/permissionManage/roles/role_perm/:role_id |
更新角色权限 |
| 方法 |
路径 |
说明 |
| POST |
/job |
提交任务 |
| GET |
/job |
任务列表 |
| GET |
/job/wait |
等待任务列表 |
| GET |
/job/stats |
任务统计 |
| DELETE |
/job/:id |
取消或删除排队任务 |
| GET |
/job/gpus |
获取 GPU 列表 |
| GET |
/job/conda-envs |
获取远程 Conda 环境列表 |
| 方法 |
路径 |
说明 |
| GET |
/queue |
查询任务队列 |
| POST |
/queue |
重排任务队列 |
| DELETE |
/queue/:jobId |
从队列移除任务 |
| 方法 |
路径 |
说明 |
| GET |
/files/list |
获取默认路径文件列表 |
| GET |
/files/list/*path |
获取指定路径文件列表 |
| DELETE |
/files/delete |
删除文件或目录 |
| POST |
/files/upload |
上传文件 |
| GET |
/files/upload/progress |
获取上传进度 |
| GET |
/files/download |
下载文件 |
| POST |
/files/unzip |
解压文件 |
| GET |
/files/size |
计算文件或目录大小 |
| 方法 |
路径 |
说明 |
| GET |
/directories/calculate-usage |
计算目录磁盘占用 |
| GET |
/directories/list-home |
列出用户目录 |
| GET |
/directories/list-home/*path |
列出指定路径下的用户目录 |
| 方法 |
路径 |
说明 |
| GET |
/admin/disk-usage/all |
获取所有用户磁盘使用情况 |
| 方法 |
路径 |
说明 |
| GET |
/terminal/ws |
远程终端 WebSocket |
详细协议见 terminal_ws_spec.md。
| 方法 |
路径 |
说明 |
| GET |
/system |
系统实时信息 WebSocket |
| POST |
/system/:pid/terminate |
终止进程 |
| POST |
/system/:pid/retain |
保留进程 |
| DELETE |
/system/:pid/retain |
取消进程保留 |
| GET |
/system/config |
获取系统采集配置 |
| PUT |
/system/config |
更新系统采集配置 |
| 方法 |
路径 |
说明 |
| GET |
/home/overview |
首页概览 |
| GET |
/home/ws |
首页实时信息 WebSocket |
| 方法 |
路径 |
说明 |
| GET |
/operationLogs/adminLog/list |
管理员操作日志列表 |
| GET |
/operationLogs/userLog/list |
用户操作日志列表 |