Clanforge API
注意：本页上的内容适用于 Clanforge。如果使用 Multiplay Hosting，请参阅 Multiplay Hosting 文档。
更新游戏镜像二进制文件（版本）的方法主要有两种：Clanforge Web 界面和 Clanforge API。本文将详细介绍如何通过 Clanforge API 进行更新。
先决条件
- 您已完成 Clanforge 集成流程。
- 您已从集成团队接收到服务标识符。
- 您已拥有经过更新的游戏镜像并准备将其部署到机群。
- 您拥有自己的服务标识符文档。
这些说明假定您在 Steam 上拥有准备就绪的新游戏版本，且拥有 S3 存储桶或 Google Cloud 存储桶。如果您选择让 Clanforge 支持团队将游戏版本手动安装到跳转机，则可以跳过在版本机器上创建镜像更新。
流程概述
通过 Clanforge API 更新游戏镜像的流程包括以下步骤：
Unity 建议您测试版本机器上的游戏镜像，然后继续，执行从步骤一到步骤二的操作。
 |
步骤 1：在版本机器上创建镜像更新
使用创建镜像更新终端将更新的游戏镜像部署到您的版本机器。您可以选择使用 Steam、Google Cloud 或 AWS。如果您的游戏镜像未配置云存储桶或 Steam 帐户，请联系 Multiplayer 支持团队。
建议您先测试版本机器上的已更新游戏镜像，然后再继续执行该流程的下一步。这样可以确保在将更新的游戏镜像部署到剩余的基础架构中前，您已发现存在的各种问题。
步骤 2：对比更新版本和原版本，创建差异分析
根据版本机器上经过更新的游戏镜像，使用创建镜像差异终端创建差异分析。生成差异分析后，您可以查看差异分析创建任务的状态，拒绝差异分析，或根据差异分析创建新的镜像版本。
操作 | 终端 | 说明 |
|---|---|---|
查看差异分析状态 | 发送创建差异分析的请求后，您可以使用镜像差异状态终端来查看差异分析任务当前的状态。 | |
拒绝差异分析 | 如果发生任何意外更改，则拒绝差异分析的结果（使用唯一的差异 ID 值）。拒绝差异分析后，您可以生成新的差异分析。如果您在尚未拒绝或接受未完成的差异分析时就尝试针对相同的镜像执行新的差异分析，则会收到错误，表示该镜像已被差异 ID XXXX 锁定。 | |
重试差异分析 | 如果差异分析失败，请进行故障排除，然后重新尝试差异分析。 | |
根据差异分析创建新的镜像版本 | 根据差异分析创建新的镜像版本与接受差异分析结果可以达到相同效果。 |
步骤 3：根据差异分析创建新的镜像版本。
要接受通过差异分析生成的更改，请搭配使用创建镜像版本终端和创建镜像差异请求返回的差异 ID。创建镜像版本终端会使用差异分析（如请求正文中的差异 ID 所指定），将差异进行打包，一旦完成便会触发部署到您的机群的操作。
调用创建镜像版本终端后，您可以调用镜像版本状态终端，以查看此打包过程的状态。下表介绍了镜像版本状态终端的状态（任务状态）。
任务状态 ID (jobstateid) | 描述 |
|---|---|
1 | 已创建（新任务） |
2 | 待处理（等待排队） |
3 | 排队中（等待处理） |
4 | 运行中（正在处理） |
5 | 完成（成功并触发部署流程） |
6 | 失败（未能成功） |
步骤 4：监控部署到机器的进度
成功完成镜像版本后，平台开始将镜像部署到机器。使用镜像部署状态来观察其进度。
在部署期间，使用此镜像的配置文件仍可用于分配。然而，建议的最佳做法是避免使用这些配置文件。机器可能尚未收到更新，底层文件在使用过程中可能会发生变化，这可能会导致意外行为。
因此，建议改用零停机补丁，以确保版本在使用前已完全部署。