mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
adf45618ec
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
29 lines
1.1 KiB
Plaintext
29 lines
1.1 KiB
Plaintext
---
|
|
title: "触发预览部署"
|
|
description: "为特定分支创建或更新预览部署，以便在合并到生产环境之前审阅文档更改。"
|
|
openapi: "/zh/openapi.json POST /project/preview/{projectId}"
|
|
keywords: ["preview", "preview deployment", "branch preview", "staging"]
|
|
---
|
|
|
|
<Info>
|
|
预览部署适用于 [Pro 和 Enterprise 方案](https://mintlify.com/pricing?ref=preview-deployments)。
|
|
</Info>
|
|
|
|
使用此端点以编程方式为 Git 分支创建或更新预览部署。如果指定分支已存在预览，该端点将触发重新部署，而不会创建重复项。
|
|
|
|
响应中包含一个 `statusId`，你可以将其传递给 [Get deployment status](/zh/api/update/status) 以跟踪部署进度。
|
|
|
|
<div id="use-cases">
|
|
## 用例
|
|
</div>
|
|
|
|
- **CI/CD 流水线**：在拉取请求被打开或更新时自动创建预览部署。
|
|
- **定时预览**：按计划为长期运行的功能分支生成预览。
|
|
- **自定义工具**：将预览创建集成到内部工作流或 Slack 机器人中。
|
|
|
|
<div id="rate-limits">
|
|
## 速率限制
|
|
</div>
|
|
|
|
此端点允许每个组织每分钟最多 5 个请求。
|