托管游戏服务器主机 (Clanforge) API

注意:此页面上的内容与托管游戏服务器主机 (Clanforge) 相关。如果您使用的是游戏服务器主机 (Multiplay),请参考游戏服务器主机 (Multiplay) 文档.

有两种主要方法可以更新您的游戏镜像二进制文件 (构建):通过游戏服务器主机网页界面,或通过游戏服务器主机 API。本主题详细介绍了通过游戏服务器主机 API 更新的过程。

先决条件

  • 您已完成游戏服务器主机集成过程。
  • 您已从集成团队获得您的服务标识符。
  • 您有一个更新的游戏镜像,准备部署到您的舰队。
  • 您拥有您的服务标识符文档。

这些说明假设您在 Steam 中准备了一个新的游戏构建,并有一个 S3 存储桶或 Google Cloud 存储桶。如果您选择让游戏服务器主机支持团队将您的游戏构建手动安装到您的跳转机器,您可以跳过在您的构建机器上创建镜像更新

流程概述

通过游戏服务器主机 API 更新游戏镜像的流程包括以下步骤

  1. 在您的构建机器上创建镜像更新.
  2. 从更新中创建差异分析.
  3. 从差异分析结果创建新的镜像版本.

Unity 建议您在从步骤一继续到步骤二之前,在您的构建机器上测试您的游戏镜像。

更新游戏镜像工作流程。

步骤 1在您的构建机器上创建镜像更新

使用镜像更新创建端点将更新的游戏镜像部署到您的构建机器。您可以选择使用 Steam、Google Cloud 或 AWS。如果您没有配置有云存储桶或 Steam 帐户的游戏镜像,请联系多人游戏支持团队。

建议您在继续此流程的下一步之前,在您的构建机器上测试更新的游戏镜像。这将确保您在将更新的游戏镜像部署到您的其余基础设施之前识别任何问题。

步骤 2从更新中创建差异分析

使用镜像差异创建端点基于您的构建机器上更新的游戏镜像创建差异分析(也称为差异分析)。当您生成差异分析后,您可以检查差异分析创建作业的状态,拒绝差异分析,或从差异分析创建新的镜像版本。

操作

端点

解释

检查差异分析状态

镜像差异状态

在您发送创建差异分析的请求后,您可以使用镜像差异状态端点检查差异分析作业的当前状态。

拒绝差异分析

镜像差异拒绝

如果差异分析有任何意外更改,请拒绝差异分析的结果(使用差异的唯一差异 ID 值)。在您拒绝差异分析后,您可以生成新的差异分析。如果您尝试从同一个游戏镜像生成另一个差异分析,但在拒绝或接受未决的差异分析之前,您会收到一条错误消息,指出该镜像被差异 ID XXXX 锁定。

重试差异分析

镜像差异重试

如果差异分析失败,请对失败进行故障排除,然后重试差异分析。

从差异分析创建新的镜像版本

镜像版本创建

从差异分析创建新的镜像版本与接受差异分析的结果相同。

步骤 3从差异分析创建新的镜像版本

要接受从差异分析生成的更改,请使用镜像版本创建端点,并使用镜像差异创建请求返回的差异 ID。镜像版本创建端点使用差异分析(如请求主体中的差异 ID 所指定),打包差异,并在完成后触发对您的舰队的推广。

在您调用镜像版本创建端点后,您可以调用镜像版本状态端点以检查此打包过程的状态。下表描述了镜像版本状态端点的状态(作业状态)。

作业状态 ID (jobstateid)

描述

1

已创建 (新作业)

2

待处理 (等待排队)

3

已排队 (等待处理)

4

正在运行 (处理中)

5

已完成 (成功并触发推广过程)

6

失败 (失败)

步骤 4监控推广到机器的进度

镜像版本成功完成之后,平台会开始将镜像推广到机器。使用镜像推广状态来观察其进度。

在推广进行时,使用此镜像的配置文件仍然可以用于分配。但是,建议您不要使用这些配置文件。机器可能尚未收到更新,并且基础文件可能在使用时发生更改,这会导致意外行为。

相反,建议零停机时间修补以确保在使用之前已完全推广构建。