立即开始

开发者工具:API 令牌、REST API、命令行工具和“解释此错误”。

创建权限范围合适的 API 令牌,通过 REST API 在脚本和 CI 中操作应用,使用 rivervo 命令行工具,以及由 AI 解释失败的部署。

1 分钟阅读

您在控制面板中对应用进行的所有操作都可以脚本化——从 CI 部署、用脚本设置变量、在终端查看日志。

API 令牌

账户设置 → API 令牌 → 创建令牌。为令牌命名(说明用途,例如“GitHub Actions”),并选择其权限:

权限范围允许的操作
只读应用、部署及其日志、运行日志、域名
读取和部署读取,以及部署、回滚和重启
完全访问部署,以及变量(读取和修改)和域名(添加、移除)
完全访问和终端完全访问,以及在您的网站上执行命令、操作其文件、定时任务、SSH 密钥和从 Git 部署

您还可以设置有效期——30、90 或 365 天后过期,或永不过期。

  • 令牌只显示一次——请立即复制。
  • 令牌以您的权限执行操作。在他人的账户中,它以您在该应用中的角色执行操作,并额外受令牌权限范围的限制。请参阅应用的访问权限。
  • 您最多可持有 20 个令牌。撤销会立即停用令牌。
  • 只有您本人可以创建自己的令牌:代您登录账户的人无法创建。

REST API

API 文档采用 OpenAPI 3.1 格式:api.rivervo.com/api/v1/openapi.json。可导入 Postman、Insomnia 或代码生成器。

基础地址:https://api.rivervo.com/api/v1。以 Bearer 令牌方式发送令牌:

curl -H "Authorization: Bearer $RIVERVO_TOKEN" https://api.rivervo.com/api/v1/apps

可执行的操作:

方法和路径作用权限范围
GET /apps您的应用及其服务读取
GET /apps/{id}单个应用读取
GET /apps/{id}/deployments应用的部署读取
POST /apps/{id}/deployments部署:构建最新提交,或使用 {"rebuild": false} 重新部署当前版本部署
GET /apps/{id}/deployments/{deployment}单次部署及其构建日志读取
POST /apps/{id}/deployments/{deployment}/rollback回到该版本部署
POST /apps/{id}/restart重启部署
GET /apps/{id}/logs网站、后台任务进程或定时任务的运行日志读取
GET, PUT, PATCH /apps/{id}/env读取、替换或更新变量完全
GET /apps/{id}/domains域名读取
POST /apps/{id}/domains, DELETE /apps/{id}/domains/{name}添加或移除域名完全
  • **他人的账户:**添加请求头 X-Account: <该账户的客户 ID>,即可操作您被授予访问权限的账户中的应用。
  • **限制:**每人每分钟 120 次请求,其中修改操作 30 次。超出后 API 返回 429 及 Retry-After。
  • **语言:**默认以英文返回消息;发送 Accept-Language: az 或 ru 可获得阿塞拜疆语或俄语消息。
  • 通过 API 修改的变量与在控制面板中一样,在下次部署时生效——使用 {"rebuild": false} 即可。

rivervo 命令行工具

在终端中进行部署、查看日志、设置变量和回滚,使用同样的 API 令牌。需要 Node.js 22 或更高版本:

npm install -g rivervo
rivervo login                       # 粘贴令牌
rivervo deploy shop                 # 构建最新提交并跟踪部署
rivervo logs shop -f                # 实时查看应用输出
rivervo env set shop API_URL=https://example.com
rivervo rollback shop               # 回到上一个版本

在 CI 中,它从 RIVERVO_TOKEN 变量读取令牌;新版本未能上线时,deploy 会以错误退出,因此可用于把控流水线。在其正式发布之前,可以通过 REST API 实现同样的操作。

“解释此错误”

部署未完成或服务停止工作时,日志旁会出现解释此错误。它会读取日志的最后几行,并用您的语言告诉您:

  • 可能的原因——出了什么问题;
  • 如何修复——针对您技术栈的具体步骤。

解释由 AI 根据日志生成;在做任何更改前请先核实。发送之前,日志中您的所有变量值以及任何看起来像密钥、密码或令牌的内容都会被隐藏。您的代码和变量本身绝不会被发送。

每人每天最多可请求 10 次新的解释;针对同一日志已生成的解释可免费再次查看。

Rivervo MCP

您还可以通过 Rivervo MCP 在 AI 助手中操作应用——它支持 Claude、ChatGPT、Cursor、VS Code 以及其他支持 MCP 的应用:在对话中询问部署、日志和错误,并让助手替您部署或回滚。无需令牌,使用您的 Rivervo 账户登录即可。请参阅Rivervo MCP。

还有疑问?

和我们聊聊——AI 即时回答,需要时工程师加入,全天候在线。

联系技术支持