

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

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

在建置Amazon GameLift Servers遊戲託管解決方案和其他功能時，使用此任務型清單來尋找 API 操作。SDK 在 `aws.gamelift` 命名空間中 AWS 包含這些操作。[下載 AWS SDK ](https://aws.amazon.com/developer/tools/#SDKs)或[檢視 Amazon GameLift Servers API 參考文件](https://docs.aws.amazon.com/gameliftservers/latest/apireference/Welcome.html)。您也可以使用 API 搭配 AWS 命令列界面 (AWS CLI)，如[AWS 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 的清單，請參閱 [FleetIQ API 操作](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html)。如需配對的 FlexMatch API 清單，請參閱 [FlexMatch API 操作](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/reference-awssdk-flex.html)。 APIs 

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

呼叫這些操作來設定遊戲伺服器的託管資源、擴展容量以滿足玩家需求、取得效能和用量指標等。使用 託管遊戲伺服器時，請使用這些 API 操作Amazon GameLift Servers，包括Amazon GameLift Servers Realtime。您也可以在[Amazon GameLift Servers主控台](https://console.aws.amazon.com/gamelift/)中處理大多數資源管理任務，也可以使用 AWS Command Line Interface (AWS CLI) 工具進行呼叫。

### 準備遊戲伺服器以進行部署
<a name="reference-awssdk-resources-servers"></a>

上傳並設定遊戲的遊戲伺服器程式碼，以準備在託管資源上進行部署和啟動。

**管理自訂遊戲伺服器組建**
+ [upload-build](https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html) – 從本機路徑上傳建置檔案，並建立新的Amazon GameLift Servers建置資源。此操作以 AWS CLI 命令的形式提供，是上傳遊戲伺服器組建的最常見方式。
+ [CreateBuild](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html) – 使用存放在 Amazon S3 儲存貯體中的檔案建立新的組建。
+ [ListBuilds](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListBuilds.html) – 取得上傳至 Amazon GameLift Servers區域的所有組建清單。
+ [DescribeBuild](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeBuild.html) – 擷取與組建相關聯的資訊。
+ [UpdateBuild](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateBuild.html) – 變更建置中繼資料，包括建置名稱和版本。
+ [DeleteBuild](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteBuild.html) – 從 移除組建Amazon GameLift Servers。

**管理Amazon GameLift Servers Realtime組態指令碼** 
+ [CreateScript](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateScript.html) – 上傳 JavaScript 檔案並建立新的Amazon GameLift Servers指令碼資源。
+ [ListScripts](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListScripts.html) – 取得上傳至 Amazon GameLift Servers區域的所有Realtime指令碼清單。
+ [DescribeScript](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeScript.html) – 擷取與Realtime指令碼相關聯的資訊。
+ [UpdateScript](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) – 變更指令碼中繼資料並上傳修訂的指令碼內容。
+ [DeleteScript](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteScript.html) – 從 移除Realtime指令碼Amazon GameLift Servers。

### 設定用於託管的運算資源
<a name="reference-awssdk-resources-fleets"></a>

設定託管資源，並使用遊戲伺服器建置或Realtime組態指令碼進行部署。

**建立和管理機群**
+ [CreateFleet](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleet.html) – 設定和部署新的運算資源Amazon GameLift Servers機群，以執行您的遊戲伺服器。部署後，遊戲伺服器會依設定自動啟動，並準備好託管遊戲工作階段。
+ [ListFleets](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListFleets.html) – 取得Amazon GameLift Servers區域中所有機群的清單。
+ [DeleteFleet](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteFleet.html) – 移除不再執行遊戲伺服器或託管玩家的機群。
+ 檢視/更新機群位置。
  + [CreateFleetLocations](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateFleetLocations.html) – 將遠端位置新增至支援多個位置的現有機群
  + [DescribeFleetLocationAttributes](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationAttributes.html) – 取得機群的所有遠端位置清單，並檢視每個位置的目前狀態。
  + [DeleteFleetLocations](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteFleetLocations.html) – 從支援多個位置的機群中移除遠端位置。
+ 檢視/更新機群組態。
  + [DescribeFleetAttributes](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetAttributes.html) / [UpdateFleetAttributes](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetAttributes.html) – 檢視或變更機群的中繼資料和設定，以保護遊戲工作階段和資源建立限制。
  + [DescribeFleetPortSettings](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetPortSettings.html) / [UpdateFleetPortSettings](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings.html) – 檢視或變更機群允許的傳入許可 (IP 地址和連接埠設定範圍）。
  + [DescribeRuntimeConfiguration](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeRuntimeConfiguration.html)/[UpdateRuntimeConfiguration](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateRuntimeConfiguration.html) – 檢視或變更要在機群中每個執行個體上執行的伺服器程序 （和數量）。

**管理機群容量**
+ [DescribeEC2InstanceLimits](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html) – 擷取目前 AWS 帳戶和目前用量層級允許的執行個體數目上限。
+ [DescribeFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) – 擷取機群主要區域的目前容量設定。
+ [DescribeFleetLocationCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) – 擷取多位置機群每個位置的目前容量設定。
+ [UpdateFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html) – 手動調整機群的容量設定。
+ 設定 ：
  + [PutScalingPolicy](https://docs.aws.amazon.com/gamelift/latest/apireference/API_PutScalingPolicy.html) – 開啟目標型自動擴展或建立自訂自動擴展政策，或更新現有政策。
  + [DescribeScalingPolicies](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeScalingPolicies.html) – 擷取現有的自動擴展政策。
  + [DeleteScalingPolicy](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteScalingPolicy.html) – 刪除自動擴展政策，並防止其影響機群的容量。
  + [StartFleetActions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartFleetActions.html) – 重新啟動機群的自動擴展政策。
  + [StopFleetActions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html) – 暫停機群的自動擴展政策。

**監控機群活動。**
+ [DescribeFleetUtilization](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetUtilization.html) – 擷取目前在機群上作用中之伺服器程序、遊戲工作階段和玩家數量的統計資料。
+ [DescribeFleetLocationUtilization](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html) – 擷取多位置機群中每個位置的使用率統計資料。
+ [DescribeFleetEvents](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html) – 檢視指定時間範圍內機群的記錄事件。
+ [DescribeGameSessions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html) – 擷取遊戲工作階段中繼資料，包括遊戲的執行時間和目前的玩家計數。

### 設定遊戲工作階段置放的佇列
<a name="reference-awssdk-resources-queues"></a>

您可以設定多機群、多區域佇列，以使用成本、延遲性和彈性最佳的可用託管資源來放置遊戲工作階段。
+ [CreateGameSessionQueue](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html) – 建立佇列，以便在處理遊戲工作階段置放的請求時使用。
+ [DescribeGameSessionQueues](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html) – 擷取 Amazon GameLift Servers區域中定義的遊戲工作階段佇列。
+ [UpdateGameSessionQueue](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html) – 變更遊戲工作階段佇列的組態。
+ [DeleteGameSessionQueue](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html) – 從區域移除遊戲工作階段佇列。

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

您可以使用別名來表示機群，或是建立終端機替代目的地。當您將遊戲活動從一個機群轉移到另一個機群 (例如遊戲伺服器建置更新期間) 時，別名便可派上用場。
+ [CreateAlias](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateAlias.html) – 定義新的別名，並選擇性地將其指派給機群。
+ [ListAliases](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListAliases.html) – 取得 區域中定義的所有機群別名Amazon GameLift Servers。
+ [DescribeAlias](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeAlias.html) – 擷取現有別名的資訊。
+ [UpdateAlias](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateAlias.html) – 變更別名的設定，例如從一個機群重新導向到另一個機群。
+ [DeleteAlias](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteAlias.html) – 從區域移除別名。
+ [ResolveAlias](https://docs.aws.amazon.com/gamelift/latest/apireference/API_ResolveAlias.html) – 取得指定別名指向的機群 ID。

### 連線至受管託管執行個體
<a name="reference-awssdk-resources-instances"></a>

您可以檢視機群中個別執行個體的資訊，或是請求遠端存取指定的機群執行個體以進行故障診斷。
+ [DescribeInstances](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html) – 取得機群中每個執行個體的資訊，包括執行個體 ID、IP 地址、位置和狀態。
+ [GetInstanceAccess](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess.html) – 請求從遠端連線至機群中指定執行個體所需的存取憑證。

### 設定 VPC 對等互連
<a name="reference-awssdk-resources-vpc"></a>

建立和管理Amazon GameLift Servers託管資源和其他 AWS 資源之間的 VPC 互連連線。
+ [CreateVpcPeeringAuthorization](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html) – 授權與其中一個 VPCs 的對等連線。
+ [DescribeVpcPeeringAuthorizations](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringAuthorizations.html) – 擷取有效的互連連線授權。
+ [DeleteVpcPeeringAuthorization](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringAuthorization.html) – 刪除對等連線授權。
+ [CreateVpcPeeringConnection](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html) – 在機Amazon GameLift Servers群的 VPC 與其中一個 VPCs之間建立對等連線。
+ [DescribeVpcPeeringConnections](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html) – 擷取與 Amazon GameLift Servers機群之作用中或待定 VPC 對等互連的相關資訊。
+ [DeleteVpcPeeringConnection](https://docs.aws.amazon.com/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 Servers Realtime用戶端 API (C\#)](https://docs.aws.amazon.com/gameliftservers/latest/realtimeguide/realtime-sdk-csharp-ref.html) 管理遊戲工作階段。
+ **為一或多個玩家啟動新的遊戲工作階段。**
  + [StartGameSessionPlacement](https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) – 要求 Amazon GameLift Servers 尋找最佳的可用託管資源，並開始新的遊戲工作階段。這是建立新遊戲工作階段的偏好方法。它依賴遊戲工作階段佇列來追蹤跨多個區域的託管可用性，並使用FleetIQ演算法根據玩家延遲、託管成本、位置等來排定置放的優先順序。
  + [DescribeGameSessionPlacement](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html) – 取得置放請求的詳細資訊和狀態。
  + [StopGameSessionPlacement](https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopGameSessionPlacement.html) – 取消置放請求。
  + [CreateGameSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSession.html) – 在特定機群位置啟動新的空遊戲工作階段。此操作可讓您更好地控制從何處開始遊戲工作階段，而不是使用 FleetIQ 來評估置放選項。您必須在不同的步驟中將玩家新增至新的遊戲工作階段。
+ **讓玩家進入現有的遊戲工作階段。**尋找具有可用玩家位置的執行中遊戲工作階段，並將其保留給新玩家。
  + [CreatePlayerSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html) – 為玩家預留開放位置，以加入遊戲工作階段。
  + [CreatePlayerSessions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html) – 為多個玩家預留開放位置，以加入遊戲工作階段。
+ **使用遊戲工作階段和玩家工作階段資料。**管理遊戲工作階段和玩家工作階段的相關資訊。
  + [SearchGameSessions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_SearchGameSessions.html) – 根據一組搜尋條件，請求作用中遊戲工作階段的清單。
  + [DescribeGameSessions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html) – 擷取特定遊戲工作階段的中繼資料，包括作用中的時間長度和目前的玩家計數。
  + [DescribeGameSessionDetails](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionDetails.html) – 擷取一或多個遊戲工作階段的中繼資料，包括遊戲工作階段保護設定。
  + [DescribePlayerSessions](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribePlayerSessions.html) – 取得玩家活動的詳細資訊，包括狀態、播放時間和玩家資料。
  + [UpdateGameSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) – 變更遊戲工作階段設定，例如玩家計數上限和聯結政策。
  + [GetGameSessionLogUrl](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html) – 取得遊戲工作階段儲存日誌的位置。