亞馬遜GameLift服務 API 參考 (AWSSDK)

本主題提供與 Amazon 託管主機解決方案搭配使用的 API 操作清單，包括託GameLift管自訂遊戲伺服器和即時伺服器。這些作業會封裝到命aws.gamelift名空間中的 AWS SDK 中。 下載開AWS發套件或檢視亞馬遜 GameLift API 參考文件。

該 API 包含兩組用於託管遊戲託管的操作：

• 設置和管理亞馬遜GameLift託管資源

• 開始遊戲工作階段並加入玩家

亞馬遜GameLift服務 API 還包含與其他亞馬遜GameLift工具和解決方案一起使用的操作。如需 FleetIQ API 的清單，請參閱 F le etIQ API 動作。如需配對的 FlexMatch API 清單，請參閱 FlexMatchAPI 動作。

設置和管理亞馬遜GameLift託管資源

呼叫這些作業以設定遊戲伺服器的託管資源、擴充容量以符合玩家需求、存取效能和使用率指標等。這些 API 操作可用於 Amazon 上託管的遊戲伺服器GameLift，包括即時伺服器。您可以使用 Amazon GameLift 主控台執行大部分的資源管理任務，也可以使用 AWS Command Line Interface (AWS CLI) 工具或 AWS SDK 撥打服務。

準備要部署的遊戲伺服器

上傳並配置遊戲的遊戲服務器代碼，以準備在託管資源上進行部署和啟動。

管理自訂遊戲伺服器組建

• 上傳建置 — 從本機路徑上傳建置檔案，並建立新的 Amazon GameLift 建置資源。此操作僅作為一個AWS CLI命令使用，是上傳遊戲伺服器組建的最常用方法。

• CreateBuild— 使用存放在 Amazon S3 儲存貯體中的檔案建立新組建。

• ListBuilds— 獲取上傳到亞馬遜GameLift區域的所有構建的列表。

• DescribeBuild— 擷取與組建相關聯的資訊。

• UpdateBuild— 變更組建中繼資料，包括組建名稱和版本。

• DeleteBuild— 從亞馬遜刪除構建GameLift。

管理實時服務器配置腳本

• CreateScript— 上傳JavaScript檔案並建立新的 Amazon GameLift 指令碼資源。

• ListScripts— 獲取上傳到亞馬遜GameLift區域的所有實時腳本的列表。

• DescribeScript— 擷取與「即時」指令碼相關聯的資訊。

• UpdateScript— 更改腳本元數據並上傳修改後的腳本內容。

• DeleteScript— 從亞馬遜刪除實時腳本GameLift.

設定託管的運算資源

配置託管資源並使用遊戲服務器構建或實時配置腳本部署它們。

建立和管理車隊

• CreateFleet— 配置和部署新的 Amazon 運算資源GameLift集，以執行遊戲伺服器。部署完成後，遊戲伺服器會自動依設定啟動，並準備好主持遊戲工作階段。

• ListFleets— 獲取亞馬遜GameLift地區所有艦隊的列表。

• DeleteFleet— 終止不再運行遊戲服務器或託管玩家的艦隊。

• 檢視/更新叢集位置。

  • CreateFleetLocations— 將遠端位置新增至支援多個位置的現有叢集

  • DescribeFleetLocationAttributes— 取得叢集所有遠端位置的清單，並檢視每個位置的目前狀態。

  • DeleteFleetLocations— 從支援多個位置的叢集中移除遠端位置。

• 檢視/更新機群組態。

  • DescribeFleetAttributes/UpdateFleetAttributes— 檢視或變更叢集的中繼資料和遊戲工作階段保護和資源建立限制的設定。

  • DescribeFleetPortSettings/UpdateFleetPortSettings— 檢視或變更叢集允許的輸入權限 (IP 位址和連接埠設定範圍)。

  • DescribeRuntimeConfiguration/UpdateRuntimeConfiguration— 檢視或變更叢集中每個執行個體要執行的伺服器處理序 (以及多少個)。

管理車隊容量

• 描述beEC2 InstanceLimits — 擷取目前AWS帳戶和目前使用層級允許的執行個體數目上限。

• DescribeFleetCapacity— 檢索車隊本地區域的當前容量設置。

• DescribeFleetLocationCapacity— 擷取多位置叢集每個位置的目前容量設定。

• UpdateFleetCapacity— 手動調整叢集的容量設定。

• 設定自動調整規模：

  • PutScalingPolicy— 開啟以目標為基礎的自動調整規模功能，或建立自訂自動調整規模政策，或更新現有政策。

  • DescribeScalingPolicies— 擷取現有的自動調整規模政策。

  • DeleteScalingPolicy— 刪除自動調整規模政策並阻止其影響叢集的容量。

  • StartFleetActions— 重新啟動叢集的自動調整規模政策。

  • StopFleetActions— 暫停叢集的自動調整規模政策。

監控機群活動。

• DescribeFleetUtilization— 檢索有關當前在機隊中活躍的服務器進程，遊戲會話和玩家的數量的統計信息。

• DescribeFleetLocationUtilization— 擷取多位置叢集中每個位置的使用率統計資料。

• DescribeFleetEvents— 檢視指定時間範圍內叢集的記錄事件。

• DescribeGameSessions— 檢索遊戲會話元數據，包括遊戲的運行時間和當前玩家數量。

設定佇列以實現最佳遊戲工作階段放置

您可以設定多機群、多區域佇列，以使用成本、延遲性和彈性最佳的可用託管資源來放置遊戲工作階段。

• CreateGameSessionQueue— 建立佇列以供處理遊戲工作階段刊登位置的要求時使用。

• DescribeGameSessionQueues— 擷取 Amazon GameLift 區域中定義的遊戲工作階段佇列。

• UpdateGameSessionQueue— 更改遊戲會話隊列的配置。

• DeleteGameSessionQueue— 從該地區移除遊戲工作階段佇列。

管理別名

您可以使用別名來表示機群，或是建立終端機替代目的地。當您將遊戲活動從一個機群轉移到另一個機群 (例如遊戲伺服器建置更新期間) 時，別名便可派上用場。

• CreateAlias— 定義新別名，並選擇性地將其指派給叢集。

• ListAliases— 獲取在亞馬遜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— 刪除與亞馬遜GameLift叢集的 VPC 對等連接。

開始遊戲工作階段並加入玩家

從您的遊戲用戶端服務呼叫這些操作，以開始新的遊戲工作階段、取得現有遊戲工作階段的資訊，並加入玩家參加遊戲工作階段。這些操作適用於 Amazon 上託管的自訂遊戲伺服器GameLift。如果您使用的是即時伺服器，請使用即時伺服器用戶端 API (C#) 參考.

• 為一或多個玩家啟動新的遊戲工作階段。

  • StartGameSessionPlacement— 要求亞馬遜找GameLift到最佳的可用託管資源並開始新的遊戲會話。這是創建新遊戲會話的首選方法。它依賴於遊戲會話隊列來跟踪多個區域的託管可用性，並使用 FleetIQ 算法根據玩家延遲，託管成本，位置等優先放置位置。

  • DescribeGameSessionPlacement— 取得刊登位置要求的詳細資訊和狀態。

  • StopGameSessionPlacement— 取消放置請求。

  • CreateGameSession— 在特定艦隊位置開始一個新的空遊戲會話。此操作使您可以更好地控制開始遊戲會話的位置，而不是使用 FleetIQ 來評估放置選項。您必須在單獨的步驟中將玩家新增至新的遊戲工作階段。

• 讓玩家進入現有的遊戲工作階段。查找帶有可用玩家位置的正在運行的遊戲會話，並將其保留給新玩家。

  • CreatePlayerSession-保留一個開放的插槽供玩家加入遊戲會話。

  • CreatePlayerSessions-保留開放的插槽，供多個玩家加入遊戲會話。

• 使用遊戲工作階段和玩家工作階段資料。管理有關遊戲會話和玩家會話的信息。

  • SearchGameSessions— 根據一組搜索條件請求活動遊戲會話列表.

  • DescribeGameSessions— 檢索特定遊戲會話的元數據，包括活動時間長度和當前玩家數量。

  • DescribeGameSessionDetails— 檢索一個或多個遊戲會話的元數據，包括遊戲會話保護設置。

  • DescribePlayerSessions— 獲取有關玩家活動的詳細信息，包括狀態，播放時間和播放器數據。

  • UpdateGameSession— 更改遊戲會話設置，例如最大玩家數量和加入策略。

  • GetGameSessionLogUrl— 獲取遊戲會話保存日誌的位置.