Amazon GameLift 服务 API 参考(Amazon 软件开发工具包) - Amazon GameLift
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

Amazon GameLift 服务 API 参考(Amazon 软件开发工具包)

本主题提供了基于任务的 API 操作列表,这些操作可用于 Amazon GameLift 管理的托管解决方案,包括托管自定义游戏服务器和实时服务器。这些操作被打包到 aws.gamelift 命名空间中的 Amazon 软件开发工具包中。下载 Amazon 软件开发工具包查看 Amazon GameLift API 参考文档

该 API 包括两组用于游戏托管的操作:

Amazon GameLift 服务 API 还包含用于其他 Amazon GameLift 工具和解决方案的操作。有关 FleetIQ API 的列表,请参阅 FleetIQ API 操作。有关用于对战的 FlexMatch API 列表,请参阅 FlexMatch API 操作

设置和管理 Amazon GameLift 托管资源

调用这些操作为您的游戏服务器配置托管资源,扩展容量以满足玩家需求、访问性能和利用率指标,等等。这些 API 操作与 Amazon GameLift 上托管的游戏服务器配合使用,包括实时服务器。您可以使用 Amazon GameLift 控制台处理大多数资源管理任务,也可以使用 Amazon Command Line Interface (Amazon CLI) 工具或 Amazon 软件开发工具包对服务进行调用。

准备游戏服务器以进行部署

上传并配置游戏的游戏服务器代码,为在托管资源上部署和启动做好准备。

管理自定义游戏服务器构建

  • upload-build – 从本地路径上传构建文件并创建新的 Amazon GameLift 构建资源。此操作只能作为 Amazon CLI 命令使用,是上传游戏服务器构建的最常用方法。

  • CreateBuild – 使用 Amazon S3 存储桶中存储的文件创建新构建。

  • ListBuilds – 获取上传到 Amazon GameLift 区域的所有构建的列表。

  • DescribeBuild – 检索与某个构建关联的信息。

  • UpdateBuild – 更改构建元数据,包括构建名称和版本。

  • DeleteBuild – 从 Amazon GameLift 中移除一个构建。

管理实时服务器配置脚本

  • CreateScript – 上传 JavaScript 文件并创建新的 Amazon GameLift 脚本资源。

  • ListBuilds – 获取上传到 Amazon GameLift 区域的所有实时脚本的列表。

  • DescribeScript – 检索与实时脚本关联的信息。

  • UpdateScript – 更改脚本元数据并上传修订后的脚本内容。

  • DeleteScript – 从 Amazon GameLift 中删除实时脚本。

设置用于托管的计算资源

配置托管资源并将其与游戏服务器构建或实时配置脚本一起构建。

创建和管理实例集

管理实例集容量

监控实例集活动。

设置队列以实现最佳游戏会话位置

设置多实例集、多区域队列,以使用最佳可用托管资源放置游戏会话,从而实现成本、延迟和恢复能力等方面的优势。

管理别名

使用别名来表示您的实例集,或创建终端替代目标。别名在将游戏活动从一个实例集转换到另一个实例集时非常有用,例如在游戏服务器构建更新期间。

  • CreateAlias – 定义新别名并可以选择将其分配给实例集。

  • ListAliases – 获取 Amazon GameLift 区域中定义的所有实例集别名。

  • DescribeAlias – 检索有关现有别名的信息。

  • UpdateAlias – 更改别名的设置,例如将其从一个实例集重定向到另一个实例集。

  • DeleteAlias – 从区域中删除别名。

  • ResolveAlias – 获取指定的别名指向的实例集 ID。

访问托管实例

查看有关实例集中各个实例的信息,或请求远程访问指定的实例集实例以进行故障排除。

  • DescribeInstances – 获取有关实例集中每个实例的信息,包括实例 ID、IP 地址、位置和状态。

  • GetInstanceAccess – 请求远程连接到实例集中的指定实例时所需的访问凭证。

设置 VPC 对等连接

在 Amazon GameLift 托管资源与其他 Amazon 资源之间创建和管理 VPC 对等连接。

开始游戏会话并加入玩家行列

通过游戏客户端服务调用这些操作即可开始新的游戏会话、获取有关现有游戏会话的信息以及加入玩家的游戏会话。这些操作适用于与在 Amazon GameLift 上托管的自定义游戏服务器配合使用。如果您使用的是实时服务器,请使用实时服务器客户端 API (C#) 参考管理游戏会话。

  • 为一个或多个玩家启动新游戏会话。

    • StartGameSessionPlacement – 让 Amazon GameLift 查找可用的最佳托管资源并开始新的游戏会话。这是创建新游戏会话的首选方法。它依靠游戏会话队列来跟踪多个地区的托管可用性,并使用 FleetIQ 算法根据玩家延迟、托管成本、位置等对展示位置进行优先排序。

    • DescribeGameSessionPlacement – 获取有关位置请求的详细信息和状态。

    • StopGameSessionPlacement – 取消位置请求。

    • CreateGameSession – 在一个特定实例集上启动一个新游戏会话。此操作使您可以更好地控制从何处开始游戏会话,而不必使用 FleetIQ 来评估放置选项。您必须通过单独的步骤将玩家添加到新游戏会话中。

  • 使玩家进入现有游戏会话。查找具有可用玩家位置的正在运行的游戏会话,并为新玩家预留位置。

  • 处理游戏会话和玩家会话数据。管理游戏会话和玩家会话信息。