本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
Amazon GameLift 服务 API
在构建 Amazon GameLift 游戏托管解决方案和其他功能时,使用此基于任务的列表查找 API 操作。AWS SDK 在 aws.gamelift
命名空间中包含了这些操作。下载 AWS 软件开发工具包
该 API 包括两组用于游戏托管的操作:
Amazon GameLift 服务 API 还包含用于其他 Amazon GameLift 工具和解决方案的操作。有关 FleetIQ API 的列表,请参阅 FleetIQ API 操作。有关用于对战的 FlexMatch API 列表,请参阅 FlexMatch API 操作。
管理 Amazon GameLift 托管资源
调用这些操作为您的游戏服务器配置托管资源、扩展容量以满足玩家需求、访问性能和使用情况指标,等等。使用 Amazon GameLift 托管游戏服务器(包括实时服务器)时,请使用这些 API 操作。您还可以在 Amazon GameLift 控制台
准备游戏服务器以进行部署
上传并配置游戏的游戏服务器代码,为在托管资源上部署和启动做好准备。
管理自定义游戏服务器构建
-
upload-build – 从本地路径上传构建文件并创建新的 Amazon GameLift 构建资源。此操作可作为 AWS CLI 命令使用,是上传游戏服务器生成包的最常用方法。
-
CreateBuild – 使用 Amazon S3 存储桶中存储的文件创建新构建。
-
ListBuilds – 获取上传到 Amazon GameLift 区域的所有构建的列表。
-
DescribeBuild – 检索与某个构建关联的信息。
-
UpdateBuild – 更改构建元数据,包括构建名称和版本。
-
DeleteBuild – 从 Amazon GameLift 中移除一个构建。
管理实时服务器配置脚本
-
CreateScript – 上传 JavaScript 文件并创建新的 Amazon GameLift 脚本资源。
-
ListBuilds – 获取上传到 Amazon GameLift 区域的所有实时脚本的列表。
-
DescribeScript – 检索与实时脚本关联的信息。
-
UpdateScript – 更改脚本元数据并上传修订后的脚本内容。
-
DeleteScript – 从 Amazon GameLift 中删除实时脚本。
设置用于托管的计算资源
配置托管资源并将其与游戏服务器构建或实时配置脚本一起构建。
创建和管理实例集
-
CreateFleet – 配置和部署新的 Amazon GameLift 计算资源实例集来运行您的游戏服务器。部署后,游戏服务器将按照配置自动启动,随时可以托管游戏会话。
-
ListFleets – 获取 Amazon GameLift 区域中所有实例集的列表。
-
DeleteFleet – 删除不再运行游戏服务器或托管玩家的实例集。
-
查看/更新实例集位置。
-
CreateFleetLocations – 将远程位置添加到支持多个位置的现有实例集中
-
DescribeFleetLocationAttributes – 获取实例集所有远程位置的列表并查看每个位置的当前状态。
-
DeleteFleetLocations – 从支持多个位置的实例集中移除远程位置。
-
-
查看/更新实例集配置。
-
DescribeFleetAttributes/UpdateFleetAttributes – 查看或更改实例集的元数据和设置,用于游戏会话保护和资源创建限制。
-
DescribeFleetPortSettings/UpdateFleetPortSettings – 查看或更改实例集允许的入站权限(IP 地址和端口设置范围)。
-
DescribeRuntimeConfiguration/UpdateRuntimeConfiguration – 查看或更改在实例集中的每个实例上运行的服务器进程(以及数量)。
-
管理实例集容量
-
DescribeEC2InstanceLimits – 检索当前 AWS 账户允许的最大实例数和当前使用量级别。
-
DescribeFleetCapacity – 检索实例集主区域当前容量设置。
-
DescribeFleetLocationCapacity – 检索多位置实例集中每个位置的当前容量设置。
-
UpdateFleetCapacity – 手动调整实例集容量设置。
-
设置 :
-
PutScalingPolicy – 启用基于目标的自动扩缩,创建自定义自自动扩缩策略,或者更新现有策略。
-
DescribeScalingPolicies – 检索现有的自动扩缩策略。
-
DeleteScalingPolicy – 删除自动扩缩策略并阻止其影响实例集的容量。
-
StartFleetActions – 重新启动实例集的自动扩缩策略。
-
StopFleetActions – 暂停实例集的自动扩缩策略。
-
监控实例集活动。
-
DescribeFleetUtilization – 检索有关当前在实例集上处于活动状态的服务器进程、游戏会话和玩家数量的统计信息。
-
DescribeFleetLocationUssivation – 检索多位置实例集中每个位置的利用率统计信息。
-
DescribeFleetEvents – 查看在指定的时间范围内实例集的已记录事件。
-
DescribeGameSessions – 检索游戏会话元数据,包括游戏的运行时间和当前玩家数量。
为游戏会话放置设置队列
设置多实例集、多区域队列,以使用最佳可用托管资源放置游戏会话,从而实现成本、延迟和恢复能力等方面的优势。
-
CreateGameSessionQueue – 创建一个队列,在处理游戏会话位置请求时使用。
-
DescribeGameSessionQueues – 检索 Amazon GameLift 区域中定义的游戏会话队列。
-
UpdateGameSessionQueue – 更改游戏会话队列的配置。
-
DeleteGameSessionQueue – 从该区域删除游戏会话队列。
管理别名
使用别名来表示您的实例集,或创建终端替代目标。别名在将游戏活动从一个实例集转换到另一个实例集时非常有用,例如在游戏服务器构建更新期间。
-
CreateAlias – 定义新别名并可以选择将其分配给实例集。
-
ListAliases – 获取 Amazon GameLift 区域中定义的所有实例集别名。
-
DescribeAlias – 检索有关现有别名的信息。
-
UpdateAlias – 更改别名的设置,例如将其从一个实例集重定向到另一个实例集。
-
DeleteAlias – 从区域中删除别名。
-
ResolveAlias – 获取指定的别名指向的实例集 ID。
连接到托管式托管实例
查看有关实例集中各个实例的信息,或请求远程访问指定的实例集实例以进行故障排除。
-
DescribeInstances – 获取有关实例集中每个实例的信息,包括实例 ID、IP 地址、位置和状态。
-
GetInstanceAccess – 请求远程连接到实例集中的指定实例时所需的访问凭证。
设置 VPC 对等连接
在 Amazon GameLift 托管资源与其他 AWS 资源之间创建和管理 VPC 对等连接。
-
CreateVpcPeeringAuthorization – 授权与其中一个 VPC 建立对等连接。
-
DescribeVpcPeeringAuthorizations – 检索有效的对等连接授权。
-
DeleteVpcPeeringAuthorization – 删除对等连接授权。
-
CreateVpcPeeringConnection – 在 Amazon GameLift 实例集的 VPC 和您的一个 VPC 之间建立对等连接。
-
DescribeVpcPeeringConnections – 检索与 Amazon GameLift 实例集建立的活动或待处理 VPC 对等连接的信息。
-
DeleteVpcPeeringConnection – 删除与 Amazon GameLift 实例集建立的 VPC 对等连接。
开始游戏会话并加入玩家行列
通过后端服务调用这些操作即可启动新的游戏会话、获取有关现有游戏会话的信息以及让玩家加入游戏会话。这些操作适用于与在 Amazon GameLift 上托管的自定义游戏服务器配合使用。如果您使用的是实时服务器,请使用实时服务器客户端 API (C#) 参考管理游戏会话。
-
为一个或多个玩家启动新游戏会话。
-
StartGameSessionPlacement – 让 Amazon GameLift 查找可用的最佳托管资源并开始新的游戏会话。这是创建新游戏会话的首选方法。它依靠游戏会话队列来跟踪多个地区的托管可用性,并使用 FleetIQ 算法根据玩家延迟、托管成本、位置等对展示位置进行优先排序。
-
DescribeGameSessionPlacement – 获取有关位置请求的详细信息和状态。
-
StopGameSessionPlacement – 取消位置请求。
-
CreateGameSession – 在一个特定实例集上启动一个新游戏会话。此操作使您可以更好地控制从何处开始游戏会话,而不必使用 FleetIQ 来评估放置选项。您必须通过单独的步骤将玩家添加到新游戏会话中。
-
-
使玩家进入现有游戏会话。查找具有可用玩家位置的正在运行的游戏会话,并为新玩家预留位置。
-
CreatePlayerSession – 预留一个开放位置供一个玩家加入游戏会话。
-
CreatePlayerSessions – 预留多个开放位置供多个玩家加入游戏会话。
-
-
处理游戏会话和玩家会话数据。管理游戏会话和玩家会话信息。
-
SearchGameSessions – 根据一组搜索条件请求活跃的游戏会话列表。
-
DescribeGameSessions – 检索特定游戏会话的元数据,包括活跃时长和当前玩家数量。
-
DescribeGameSessionDetails – 检索一个或多个游戏会话的元数据,包括游戏会话保护设置。
-
DescribePlayerSessions – 获取有关玩家活动的详细信息,包括状态、游戏时间和玩家数据。
-
UpdateGameSession – 更改游戏会话设置,例如最大玩家数和加入政策。
-
GetGameSessionLogUrl – 获取游戏会话的已保存日志的位置。
-