项目与部署
项目就是完成后的应用。你可以把会话中构建的内容确定为项目、进行部署,出现问题时再回滚。
列表与创建
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /api/projects | 我可见的全部项目 |
POST | /api/projects | 新建项目(本文中包含 name、template —— 两者均可省略) |
POST | /api/projects/{id}/fork | 复制已有项目(本文中包含 name) |
POST | /api/projects/{id}/open | 打开编辑会话并获取该会话信息 |
名称与公开范围
| 方法 | 路径 | 请求体 |
|---|---|---|
PATCH | /api/projects/{id} | { "name": "새 이름" } |
PATCH | /api/projects/{id} | { "access": "public" } 或 "private" |
DELETE | /api/projects/{id} | — |
public 表示只要登录 Studio 的人都可以查看,但并不免除认证本身。
部署
| 方法 | 路径 | 作用 |
|---|---|---|
POST | /api/projects/{id}/deploy | 部署当前状态,并签发新的版本号 |
GET | /api/projects/{id}/deploys | 部署历史 |
POST | /api/projects/{id}/rollback | 回退到先前版本(本文中包含 version) |
POST | /api/projects/{id}/stop | 停止部署 |
部署采用版本累积的结构,因此回滚不具破坏性 —— 回退之后,后续版本仍保留在历史记录中。
运行时
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /api/projects/{id}/runtime | 运行状态 |
GET | /api/projects/{id}/runtime/logs?tail={n} | 日志最后 n 行(默认 200) |
POST | /api/projects/{id}/runtime/restart | 重启 |
导出
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /api/projects/{id}/deploy-bundle?version={n} | 下载部署包 |
GET | /api/projects/{id}/image-push/preview | 镜像推送前的确认 |
POST | /api/projects/{id}/image-push | 推送到容器镜像仓库(本文中包含 version) |
POST | /api/projects/{id}/git-push | 推送到 Git 仓库 |
POST | /api/projects/{id}/save-template | 保存为模板(本文中包含 name、category) |
迁移到隔离网络时,下载部署包再导入比推送镜像更为简单。
文档
GET /api/projects/{id}/doc
你会获得一份说明应用功能的整理文档。这是代理在构建过程中一并编写的。