SuperAPI AI 工具集

vexdock-api

部署与运维

查看项目

更新于 10-16 01:07

技能介绍

用途:Vexdock 没有 CLI,API 是完整接口,仪表盘只是其一个客户端。本技能用 curl 与 jq 通过 REST API 和 Bearer Token 操作 Vexdock 服务器,适合需要部署、查看、重启、在服务内执行命令、查询数据库或做系统运维的场景。

使用前提:设置两个环境变量,VEXDOCK_URL 不带结尾斜杠,VEXDOCK_TOKEN 在 System → Settings → API tokens 生成且只显示一次,缺失时向用户索取,切勿回显令牌。可定义 vx() 函数复用 curl 调用。验证用 vx /api/me 与公开的 vx /api/health。

主要能力:项目与服务的创建、补丁、删除;git、image、raw compose 片段与数据库目录多种来源;部署返回 202 后轮询 /api/deployments/{id} 或 SSE 事件流;取消与回滚;服务 start/stop/restart 与容器重启;exec 在服务容器内执行命令(默认 sh,可 bash,非零退出仍为 200,需读 exit_code);Studio 列目录、查行、执行 SQL 或 MongoDB、Valkey 命令及变更;日志与统计 SSE、metrics、system 信息;三层环境变量;环境管理;域名与证书签发;cron 定时任务;Docker 清理、镜像拉取与删除;系统设置、备份、版本检查与更新、注册表。

惯例与限制:Bearer 令牌不需要 CSRF 头;请求为 JSON,未知字段返回 400。错误统一为 {"error":{"code","message"}},含 INVALID_REQUEST、UNAUTHORIZED、CONFIRMATION_REQUIRED、CONFLICT 等。ID 为不透明字符串,先列表解析不要猜测。破坏性调用需 ?confirm=true,删环境带 ?volumes=true,项目需先清空服务。exec 十分钟后放弃但命令继续运行,输出超 1 MiB 保留尾部。查询结果上限 1000 行,limit 1–500。定时任务不补跑错过的触发。系统更新会重启管理器,API 会短暂中断。完整参考见仓库 docs/api.md,公开读取仅 /api/health 与 /api/system/version。