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

# Amazon GameLift Servers 服务 API
<a name="reference-awssdk"></a>

在构建 Amazon GameLift Servers 游戏托管解决方案和其他功能时，使用此基于任务的列表查找 API 操作。S Amazon DK 在`aws.gamelift`命名空间中包含这些操作。[下载 Amazon 软件开发工具包](https://www.amazonaws.cn/developer/tools/#SDKs)或[查看 Amazon GameLift Servers API 参考文档](https://docs.amazonaws.cn/gameliftservers/latest/apireference/Welcome.html)。您还可以将 API 与 Amazon 命令行接口 (Amazon CLI) 一起使用，如[Amazon CLI 命令参考](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/index.html)中所述。

该 API 包括两组用于游戏托管的操作：
+ [管理 Amazon GameLift Servers 托管资源](#reference-awssdk-resources)
+ [开始游戏会话并加入玩家行列](#reference-awssdk-sessions)

Amazon GameLift Servers 服务 API 还包含用于其他 Amazon GameLift Servers 工具和解决方案的操作。有关列表 FleetIQ APIs，请参阅 [FleetIQAPI 操作](https://docs.amazonaws.cn/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html)。有关配对的FlexMatch APIs 列表，请参阅 [FlexMatchAPI 操作](https://docs.amazonaws.cn/gamelift/latest/flexmatchguide/reference-awssdk-flex.html)。

## 管理 Amazon GameLift Servers 托管资源
<a name="reference-awssdk-resources"></a>

调用这些操作为您的游戏服务器配置托管资源、扩展容量以满足玩家需求、访问性能和使用情况指标，等等。使用 Amazon GameLift Servers 托管游戏服务器（包括 Amazon GameLift Servers Realtime）时，请使用这些 API 操作。您还可以在 [Amazon GameLift Servers 控制台](https://console.amazonaws.cn/gamelift/)中执行大多数资源管理任务，也可以使用 Amazon Command Line Interface （Amazon CLI）工具进行调用。

### 准备游戏服务器以进行部署
<a name="reference-awssdk-resources-servers"></a>

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

**管理自定义游戏服务器构建**
+ [upload-build](https://docs.amazonaws.cn/cli/latest/reference/gamelift/upload-build.html)：从本地路径上传生成包文件并创建新的 Amazon GameLift Servers 生成包资源。此操作可用作 Amazon CLI 命令，是上传游戏服务器版本的最常用方法。
+ [CreateBuild](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreateBuild.html)— 使用存储在 Amazon S3 存储桶中的文件创建新版本。
+ [ListBuilds](https://docs.amazonaws.cn/gamelift/latest/apireference/API_ListBuilds.html)— 获取上传到某个Amazon GameLift Servers区域的所有版本的列表。
+ [DescribeBuild](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeBuild.html)— 检索与版本相关的信息。
+ [UpdateBuild](https://docs.amazonaws.cn/gamelift/latest/apireference/API_UpdateBuild.html)— 更改版本元数据，包括版本名称和版本。
+ [DeleteBuild](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DeleteBuild.html)— 从中移除构建Amazon GameLift Servers。

**管理 Amazon GameLift Servers Realtime 配置脚本** 
+ [CreateScript](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreateScript.html)— 上传 JavaScript 文件并创建新的Amazon GameLift Servers脚本资源。
+ [ListScripts](https://docs.amazonaws.cn/gamelift/latest/apireference/API_ListScripts.html)— 获取上传到某个Amazon GameLift Servers区域的所有Realtime脚本的列表。
+ [DescribeScript](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeScript.html)— 检索与Realtime脚本相关的信息。
+ [UpdateScript](https://docs.amazonaws.cn/gamelift/latest/apireference/API_UpdateScript.html)— 更改脚本元数据并上传修改后的脚本内容。
+ [DeleteScript](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DeleteScript.html)— 从中删除Realtime脚本Amazon GameLift Servers。

### 设置用于托管的计算资源
<a name="reference-awssdk-resources-fleets"></a>

配置托管资源，并通过游戏服务器生成包或 Realtime 配置脚本进行部署。

**创建和管理实例集**
+ [CreateFleet](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreateFleet.html)— 配置和部署新的计算资源Amazon GameLift Servers队列来运行您的游戏服务器。部署后，游戏服务器将按照配置自动启动，随时可以托管游戏会话。
+ [ListFleets](https://docs.amazonaws.cn/gamelift/latest/apireference/API_ListFleets.html)— 获取一个Amazon GameLift Servers地区内所有舰队的列表。
+ [DeleteFleet](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DeleteFleet.html)— 移除不再运行游戏服务器或托管玩家的舰队。
+ 查看/更新实例集位置。
  + [CreateFleetLocations](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreateFleetLocations.html)— 将远程位置添加到支持多个地点的现有舰队中
  + [DescribeFleetLocationAttributes](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeFleetLocationAttributes.html)— 获取舰队所有远程位置的列表并查看每个位置的当前状态。
  + [DeleteFleetLocations](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DeleteFleetLocations.html)— 从支持多个位置的舰队中移除远程位置。
+ 查看/更新实例集配置。
  + [DescribeFleetAttributes](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeFleetAttributes.html)/[UpdateFleetAttributes](https://docs.amazonaws.cn/gamelift/latest/apireference/API_UpdateFleetAttributes.html)— 查看或更改舰队的元数据以及游戏会话保护和资源创建限制的设置。
  + [DescribeFleetPortSettings](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeFleetPortSettings.html)/[UpdateFleetPortSettings](https://docs.amazonaws.cn/gamelift/latest/apireference/API_UpdateFleetPortSettings.html)— 查看或更改队列允许的入站权限（IP 地址和端口设置范围）。
  + [DescribeRuntimeConfiguration](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeRuntimeConfiguration.html)/[UpdateRuntimeConfiguration](https://docs.amazonaws.cn/gamelift/latest/apireference/API_UpdateRuntimeConfiguration.html)— 查看或更改队列中每个实例上要运行的服务器进程（以及多少个）。

**管理实例集容量**
+ [描述 EC2 InstanceLimits](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html)-检索当前 Amazon 账户允许的最大实例数和当前使用级别。
+ [DescribeFleetCapacity](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeFleetCapacity.html)— 检索舰队所在区域的当前容量设置。
+ [DescribeFleetLocationCapacity](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html)— 检索多地点车队中每个地点的当前容量设置。
+ [UpdateFleetCapacity](https://docs.amazonaws.cn/gamelift/latest/apireference/API_UpdateFleetCapacity.html)— 手动调整车队的容量设置。
+ 设置 ：
  + [PutScalingPolicy](https://docs.amazonaws.cn/gamelift/latest/apireference/API_PutScalingPolicy.html)— 开启基于目标的自动缩放或创建自定义自动缩放策略，或更新现有策略。
  + [DescribeScalingPolicies](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeScalingPolicies.html)— 检索现有的 auto Scaling 策略。
  + [DeleteScalingPolicy](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DeleteScalingPolicy.html)— 删除 auto Scaling 策略并阻止其影响队列的容量。
  + [StartFleetActions](https://docs.amazonaws.cn/gamelift/latest/apireference/API_StartFleetActions.html)— 重启队列的 auto Scaling 策略。
  + [StopFleetActions](https://docs.amazonaws.cn/gamelift/latest/apireference/API_StopFleetActions.html)— 暂停队列的 auto Scaling 政策。

**监控实例集活动。**
+ [DescribeFleetUtilization](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeFleetUtilization.html)— 检索队列中当前活跃的服务器进程、游戏会话和玩家数量的统计信息。
+ [DescribeFleetLocationUtilization](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html)— 检索多地点车队中每个位置的利用率统计信息。
+ [DescribeFleetEvents](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeFleetEvents.html)— 查看队列在指定时间段内记录的事件。
+ [DescribeGameSessions](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeGameSessions.html)— 检索游戏会话元数据，包括游戏的运行时间和当前玩家人数。

### 为游戏会话放置设置队列
<a name="reference-awssdk-resources-queues"></a>

设置多实例集、多区域队列，以使用最佳可用托管资源放置游戏会话，从而实现成本、延迟和恢复能力等方面的优势。
+ [CreateGameSessionQueue](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreateGameSessionQueue.html)— 创建队列，以便在处理游戏会话放置请求时使用。
+ [DescribeGameSessionQueues](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeGameSessionQueues.html)— 检索在某个Amazon GameLift Servers区域中定义的游戏会话队列。
+ [UpdateGameSessionQueue](https://docs.amazonaws.cn/gamelift/latest/apireference/API_UpdateGameSessionQueue.html)— 更改游戏会话队列的配置。
+ [DeleteGameSessionQueue](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DeleteGameSessionQueue.html)— 从该区域移除游戏会话队列。

### 管理别名
<a name="reference-awssdk-resources-aliases"></a>

使用别名来表示您的实例集，或创建终端替代目标。别名在将游戏活动从一个实例集转换到另一个实例集时非常有用，例如在游戏服务器构建更新期间。
+ [CreateAlias](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreateAlias.html)— 定义新别名并可选择将其分配给舰队。
+ [ListAliases](https://docs.amazonaws.cn/gamelift/latest/apireference/API_ListAliases.html)— 获取在某个Amazon GameLift Servers区域中定义的所有舰队别名。
+ [DescribeAlias](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeAlias.html)— 检索有关现有别名的信息。
+ [UpdateAlias](https://docs.amazonaws.cn/gamelift/latest/apireference/API_UpdateAlias.html)— 更改别名的设置，例如将其从一个舰队重定向到另一个舰队。
+ [DeleteAlias](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DeleteAlias.html)— 从该区域删除别名。
+ [ResolveAlias](https://docs.amazonaws.cn/gamelift/latest/apireference/API_ResolveAlias.html)— 获取指定别名指向的舰队 ID。

### 连接到托管式托管实例
<a name="reference-awssdk-resources-instances"></a>

查看有关实例集中各个实例的信息，或请求远程访问指定的实例集实例以进行故障排除。
+ [DescribeInstances](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeInstances.html)— 获取队列中每个实例的信息，包括实例 ID、IP 地址、位置和状态。
+ [GetInstanceAccess](https://docs.amazonaws.cn/gamelift/latest/apireference/API_GetInstanceAccess.html)— 请求远程连接到队列中指定实例所需的访问凭证。

### 设置 VPC 对等连接
<a name="reference-awssdk-resources-vpc"></a>

创建和管理您的Amazon GameLift Servers托管资源与其他资源之间的 VPC 对等 Amazon 连接。
+ [CreateVpcPeeringAuthorization](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html)— 授权与您的 VPCs其中一个建立对等连接。
+ [DescribeVpcPeeringAuthorizations](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeVpcPeeringAuthorizations.html)— 检索有效的对等连接授权。
+ [DeleteVpcPeeringAuthorization](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DeleteVpcPeeringAuthorization.html)— 删除对等连接授权。
+ [CreateVpcPeeringConnection](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html)— 在队列的 VPC 与您的Amazon GameLift Servers VPCs队伍的 VPC 之间建立对等连接。
+ [DescribeVpcPeeringConnections](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html)— 检索与Amazon GameLift Servers队列的活动或待定 VPC 对等连接的信息。
+ [DeleteVpcPeeringConnection](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html)— 删除与Amazon GameLift Servers队列的 VPC 对等连接。

## 开始游戏会话并加入玩家行列
<a name="reference-awssdk-sessions"></a>

通过后端服务调用这些操作即可启动新的游戏会话、获取有关现有游戏会话的信息以及让玩家加入游戏会话。这些操作适用于托管在 Amazon GameLift Servers 上的自定义游戏服务器。如果您正在使用 Amazon GameLift Servers Realtime，请使用 [Amazon GameLift ServersRealtime 客户端 API（C\$1）](https://docs.amazonaws.cn/gameliftservers/latest/realtimeguide/realtime-sdk-csharp-ref.html)管理游戏会话。
+ **为一个或多个玩家启动新游戏会话。**
  + [StartGameSessionPlacement](https://docs.amazonaws.cn/gamelift/latest/apireference/API_StartGameSessionPlacement.html)— Amazon GameLift Servers 要求找到最好的可用托管资源并开始新的游戏会话。这是创建新游戏会话的首选方法。该方法依靠游戏会话队列来跟踪多个区域的托管可用性，并使用 FleetIQ 算法根据玩家延迟、托管成本、位置等对放置位置进行优先排序。
  + [DescribeGameSessionPlacement](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html)— 获取安置申请的详细信息和状态。
  + [StopGameSessionPlacement](https://docs.amazonaws.cn/gamelift/latest/apireference/API_StopGameSessionPlacement.html)— 取消安置申请。
  + [CreateGameSession](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreateGameSession.html)— 在特定的舰队位置开始新的空白游戏会话。此操作使您能够更好地控制游戏会话的启动位置，而不必使用 FleetIQ 来评估放置选项。您必须通过单独的步骤将玩家添加到新游戏会话中。
+ **使玩家进入现有游戏会话。**查找具有可用玩家位置的正在运行的游戏会话，并为新玩家预留位置。
  + [CreatePlayerSession](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreatePlayerSession.html)— 为玩家预留空位以加入游戏会话。
  + [CreatePlayerSessions](https://docs.amazonaws.cn/gamelift/latest/apireference/API_CreatePlayerSessions.html)— 为多名玩家预留空位以加入游戏会话。
+ **处理游戏会话和玩家会话数据。**管理游戏会话和玩家会话信息。
  + [SearchGameSessions](https://docs.amazonaws.cn/gamelift/latest/apireference/API_SearchGameSessions.html)— 根据一组搜索条件请求活跃游戏会话列表。
  + [DescribeGameSessions](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeGameSessions.html)— 检索特定游戏会话的元数据，包括活跃时间长度和当前玩家人数。
  + [DescribeGameSessionDetails](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribeGameSessionDetails.html)— 检索一个或多个游戏会话的元数据，包括游戏会话保护设置。
  + [DescribePlayerSessions](https://docs.amazonaws.cn/gamelift/latest/apireference/API_DescribePlayerSessions.html)— 获取玩家活动的详细信息，包括状态、游戏时间和玩家数据。
  + [UpdateGameSession](https://docs.amazonaws.cn/gamelift/latest/apireference/API_UpdateGameSession.html)— 更改游戏会话设置，例如最大玩家人数和加入政策。
  + [GetGameSessionLogUrl](https://docs.amazonaws.cn/gamelift/latest/apireference/API_GetGameSessionLogUrl.html)— 获取游戏会话保存日志的位置。