Amazon GameLift サービス API - Amazon GameLift
Amazon GameLift ホスティングリソースの管理ゲームセッションをスタートし、プレイヤーを参加させる

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon GameLift サービス API

このタスクベースのリストを使用して、Amazon GameLift ゲームホスティングソリューションやその他の機能を構築する際のAPIオペレーションを検索します。 AWS SDK には、これらのオペレーションがaws.gamelift名前空間に含まれます。をダウンロードする AWS SDKか、Amazon GameLift API リファレンスドキュメント を参照してください。 AWS コマンドAWS CLI リファレンス に記載されているように、 コマンドラインインターフェイス (AWS CLI) APIで を使用することもできます。

API には、マネージドゲームホスティング用の 2 つのオペレーションセットが含まれています。

Amazon GameLift Service には、他の Amazon GameLift ツールやソリューションで使用するオペレーションAPIも含まれています。FleetIQ のリストについてはAPIs、FleetIQ APIオペレーション」を参照してください。マッチメーキングのリスト FlexMatch APIsについては、「 FlexMatch APIオペレーション」を参照してください。

Amazon GameLift ホスティングリソースの管理

これらのオペレーションを呼び出して、ゲームサーバーのホスティングリソースの設定、プレイヤーの需要を満たすための容量のスケーリング、パフォーマンスと使用状況のメトリクスの取得などを行います。リアルタイムサーバーを含む Amazon でゲームサーバーをホストする場合は GameLift、これらのAPIオペレーションを使用します。ほとんどのリソース管理タスクでは Amazon GameLift コンソールで作業することも、 AWS Command Line Interface （AWS CLI) ツールで呼び出しを実行することもできます。

デプロイ用のゲームサーバーを準備する

ホスティングリソースでのデプロイと起動の準備として、ゲームのゲームサーバーコードをアップロードして構成します。

[Manage custom game server builds](カスタム ゲームサーバー構築の管理)

  • upload-build – ローカルパスからビルドファイルをアップロードし、新しい Amazon GameLift ビルドリソースを作成します。 AWS CLI コマンドとして利用できるこのオペレーションは、ゲームサーバービルドをアップロードする最も一般的な方法です。

  • CreateBuild – Amazon S3 バケットに保存されているファイルを使用して新しいビルドを作成します。

  • ListBuilds — Amazon GameLift リージョンにアップロードされたすべてのビルドのリストを取得します。

  • DescribeBuild – ビルドに関連付けられた情報を取得します。

  • UpdateBuild – ビルド名とバージョンを含むビルドメタデータを変更します。

  • DeleteBuild – Amazon からビルドを削除します GameLift。

[Manage Realtime Servers configuration scripts](リアルタイムサーバー構成スクリプトの管理)

  • CreateScript — JavaScript ファイルをアップロードし、新しい Amazon GameLift スクリプトリソースを作成します。

  • ListScripts – Amazon GameLift リージョンにアップロードされたすべてのリアルタイムスクリプトのリストを取得します。

  • DescribeScript – リアルタイムスクリプトに関連付けられた情報を取得します。

  • UpdateScript – スクリプトメタデータを変更し、改訂されたスクリプトコンテンツをアップロードします。

  • DeleteScript – Amazon からリアルタイムスクリプトを削除します GameLift。

ホスティング用のコンピューティング リソースを設定する

ホスティングリソースを設定し、ゲーム サーバー構築またはリアル設定スクリプトとデプロイします。

[Create and manage fleets]（フリートの作成と管理）

  • CreateFleet – ゲームサーバーを実行するための新しい Amazon コンピューティングリソースの GameLift フリートを設定してデプロイします。デプロイされると、ゲームサーバーは設定に従って自動的に起動し、ゲームセッションをホストします。

  • ListFleets — Amazon GameLift リージョン内のすべてのフリートのリストを取得します。

  • DeleteFleet — ゲームサーバーを実行していないフリートや、プレイヤーをホストしていないフリートを削除します。

  • フリートロケーションの表示/更新。

    • CreateFleetLocations – 複数のロケーションをサポートする既存のフリートにリモートロケーションを追加する

    • DescribeFleetLocationAttributes – フリートのすべてのリモートロケーションのリストを取得し、各ロケーションの現在のステータスを表示します。

    • DeleteFleetLocations – 複数のロケーションをサポートするフリートからリモートロケーションを削除します。

  • フリート設定の表示/更新。

[フリートの容量を管理する

  • 説明EC2InstanceLimits — 現在の AWS アカウントと現在の使用状況レベルで許可されるインスタンスの最大数を取得します。

  • DescribeFleetCapacity – フリートのホームリージョンの現在のキャパシティ設定を取得します。

  • DescribeFleetLocationCapacity – マルチロケーションフリートの場所ごとに現在のキャパシティ設定を取得します。

  • UpdateFleetCapacity – フリートの容量設定を手動で調整します。

  • を設定します。

    • PutScalingPolicy – ターゲットベースの自動スケーリングを有効にするか、カスタム自動スケーリングポリシーを作成するか、既存のポリシーを更新します。

    • DescribeScalingPolicies – 既存の自動スケーリングポリシーを取得します。

    • DeleteScalingPolicy – 自動スケーリングポリシーを削除し、フリートの容量への影響を停止します。

    • StartFleetActions – フリートの自動スケーリングポリシーを再起動します。

    • StopFleetActions – フリートの自動スケーリングポリシーを停止します。

フリートのアクティビティをモニタリングします。

  • DescribeFleetUtilization – フリートで現在アクティブなサーバープロセス、ゲームセッション、プレイヤーの数に関する統計を取得します。

  • DescribeFleetLocationUtilization – マルチロケーションフリート内の各ロケーションの使用率統計を取得します。

  • 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ピアリング接続を作成および管理します。

ゲームセッションをスタートし、プレイヤーを参加させる

バックエンドサービスからこれらのオペレーションを呼び出して、新しいゲームセッションを開始し、既存のゲームセッションに関する情報を取得し、プレイヤーをゲームセッションに参加させます。これらのオペレーションは、Amazon でホストされているカスタムゲームサーバーで使用するためのものです GameLift。Realtime Server を使用している場合は、リアルタイムサーバークライアント API (C#) リファレンスを使用しゲームセッションを管理します。

  • 1 人以上のプレイヤーの新しいゲームセッションを開始します。

    • StartGameSessionPlacement – Amazon GameLift に、利用可能な最適なホスティングリソースを見つけて、新しいゲームセッションを開始するように依頼します。これは、推奨する新しいゲームセッションの作成方法です。複数のリージョンでホスティングの可用性を追跡するためにゲーム セッション キューに依存し、FleetIQ アルゴリズムを使用して、プレイヤーのレイテンシー、ホスティング コスト、ロケーションなどに基づいて配置の優先順位付けを行います。

    • DescribeGameSessionPlacement – プレイスメントリクエストの詳細とステータスを取得します。

    • StopGameSessionPlacement – プレイスメントリクエストをキャンセルします。

    • CreateGameSession – 特定のフリートロケーションで新しい空のゲームセッションを開始します。このオペレーションにより、FleetIQ を使用して配置オプションを評価する代わりに、ゲームセッションをスタートする場所を詳細に制御できます。別のステップで新しいゲームセッションにプレイヤーを追加する必要があります。

  • [プレイヤーを既存のゲームに参加させます。] 使用可能なプレイヤースロットがある実行中のゲームセッションを検索し、新しいプレイヤー用に予約します。

    • CreatePlayerSession — プレイヤーがゲームセッションに参加するためのオープンスロットを予約します。

    • CreatePlayerSessions — ゲームセッションに参加する複数のプレイヤー用のオープンスロットを予約します。

  • ゲームセッションとプレイヤーセッションデータを操作します。ゲームセッションとプレイヤーセッションの情報を管理できます。

    • SearchGameSessions – 一連の検索条件に基づいてアクティブなゲームセッションのリストをリクエストします。

    • DescribeGameSessions – アクティブな時間の長さや現在のプレイヤー数など、特定のゲームセッションのメタデータを取得します。

    • DescribeGameSessionDetails – 1 つ以上のゲームセッションのゲームセッション保護設定を含むメタデータを取得します。

    • DescribePlayerSessions – ステータス、再生時間、プレイヤーデータなど、プレイヤーアクティビティの詳細を取得します。

    • UpdateGameSession – 最大プレイヤー数や参加ポリシーなど、ゲームセッション設定を変更します。

    • GetGameSessionLogUrl — ゲームセッション用に保存されたログの場所を取得します。