Amazon GameLift 服務 API - Amazon GameLift

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

Amazon GameLift 服務 API

使用此任務型清單來尋找在建置 Amazon GameLift 遊戲託管解決方案和其他功能時API的操作。會在aws.gamelift命名空間中 AWS SDK包含這些操作。下載 AWS SDK檢視 Amazon GameLift API 參考文件 。您也可以將 API與 AWS 命令列介面 (AWS CLI) 搭配使用,AWS CLI 如命令參考 中所述。

API 包含兩組受管遊戲託管的操作:

Amazon GameLift Service API也包含與其他 Amazon GameLift 工具和解決方案搭配使用的操作。如需 FleetIQ 的清單APIs,請參閱 FleetIQ API操作 。如需配對的 FlexMatch APIs清單,請參閱FlexMatch API操作

管理 Amazon GameLift 託管資源

呼叫這些操作來設定遊戲伺服器的託管資源、擴展容量以滿足玩家需求、取得效能和用量指標等。使用 Amazon 託管遊戲伺服器時,請使用這些API操作 GameLift,包括即時伺服器。您也可以在 Amazon GameLift 主控台中為大多數資源管理任務工作,也可以使用 AWS Command Line Interface (AWS CLI) 工具撥打電話。

準備要部署的遊戲伺服器

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

管理自訂遊戲伺服器建置

  • upload-build – 從本機路徑上傳建置檔案,並建立新的 Amazon GameLift 建置資源。此操作以 AWS CLI 命令形式提供,是上傳遊戲伺服器建置的最常見方式。

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

  • ListBuilds – 取得上傳至 Amazon GameLift 區域的所有建置的清單。

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

  • UpdateBuild – 變更建置中繼資料,包括建置名稱和版本。

  • DeleteBuild – 從 Amazon 移除建置 GameLift。

管理即時伺服器組態指令碼

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

  • ListScripts – 取得上傳至 Amazon GameLift 區域的所有即時指令碼清單。

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

  • UpdateScript – 變更指令碼中繼資料並上傳修訂的指令碼內容。

  • DeleteScript – 從 Amazon 移除即時指令碼 GameLift。

設定用於託管的運算資源

設定託管資源,並使用遊戲伺服器建置或即時組態指令碼部署這些資源。

建立和管理機群

管理機群容量

監控機群活動。

設定遊戲工作階段置放的佇列

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

管理別名

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

  • CreateAlias – 定義新的別名,並選擇性地將其指派給機群。

  • ListAliases – 取得在 Amazon GameLift 區域中定義的所有機群別名。

  • DescribeAlias – 擷取現有別名的資訊。

  • UpdateAlias – 變更別名的設定,例如將別名從一個機群重新導向至另一個機群。

  • DeleteAlias – 從 區域移除別名。

  • ResolveAlias – 取得指定別名指向的機群 ID。

連線至受管託管執行個體

您可以檢視機群中個別執行個體的資訊,或是請求遠端存取指定的機群執行個體以進行故障診斷。

  • DescribeInstances – 取得機群中每個執行個體的資訊,包括執行個體 ID、IP 地址、位置和狀態。

  • GetInstanceAccess – 請求遠端連線至機群中指定執行個體所需的存取憑證。

設定VPC對等

建立和管理 Amazon GameLift 託管資源和其他 AWS 資源之間的VPC互連連線。

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

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

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

    • StartGameSessionPlacement – 要求 Amazon GameLift 尋找最佳的可用託管資源,並開始新的遊戲工作階段。這是建立新遊戲工作階段的偏好方法。它依賴遊戲工作階段佇列來追蹤多個區域的託管可用性,並使用 FleetIQ 演算法根據玩家延遲、託管成本、位置等來排定置放的優先順序。

    • DescribeGameSessionPlacement – 取得置放請求的詳細資訊和狀態。

    • StopGameSessionPlacement – 取消置放請求。

    • CreateGameSession – 在特定機群位置上啟動新的空遊戲工作階段。此操作可讓您更好地控制從何處開始遊戲工作階段,而不是使用 FleetIQ 來評估置放選項。您必須在不同的步驟中將玩家新增至新的遊戲工作階段。

  • 讓玩家進入現有的遊戲工作階段。尋找具有可用玩家插槽的執行遊戲工作階段,並將其保留給新的玩家。

  • 使用遊戲工作階段和玩家工作階段資料。管理遊戲工作階段和玩家工作階段的相關資訊。

    • SearchGameSessions – 根據一組搜尋條件,請求作用中遊戲工作階段的清單。

    • DescribeGameSessions – 擷取特定遊戲工作階段的中繼資料,包括作用中的時間長度和目前的玩家計數。

    • DescribeGameSessionDetails – 擷取一或多個遊戲工作階段的中繼資料,包括遊戲工作階段保護設定。

    • DescribePlayerSessions – 取得播放器活動的詳細資訊,包括狀態、播放時間和播放器資料。

    • UpdateGameSession – 變更遊戲工作階段設定,例如玩家計數上限和聯結政策。

    • GetGameSessionLogUrl – 取得遊戲工作階段的儲存日誌位置。