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

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

Amazon GameLift Servers 用サービス API

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

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

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

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

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

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

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

カスタムゲームサーバービルドの管理

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

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

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

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

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

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

Amazon GameLift Servers Realtime 設定スクリプトを管理する

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

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

  • DescribeScript - Realtime スクリプトに関連付けられた情報を取得します。

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

  • DeleteScript - Amazon GameLift Servers から Realtime スクリプトを削除します。

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

ホスティングリソースを設定し、ゲームサーバービルドまたは Realtime 設定スクリプトでデプロイします。

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

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

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

  • DeleteFleet - ゲームサーバーの実行やプレイヤーをホスティングしなくなったフリートを削除します。

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

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

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

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

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

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

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

  • DescribeFleetCapacity - フリートのホーム リージョンの現在の容量設定を取得します。

  • DescribeFleetLocationCapacity - マルチロケーションフリートの各ロケーションの現在の容量設定を取得します。

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

  • 設定:

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

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

    • DeleteScalingPolicy - 自動スケーリングポリシーを削除し、フリートの容量に影響しないようにします。

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

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

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

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

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

  • DescribeFleetEvents - 指定した期間中のフリートの記録されたイベントを表示します。

  • DescribeGameSessions - ゲームの実行時間や現在のプレイヤー数など、ゲームセッションのメタデータを取得します。

ゲームセッションの配置用キューを設定する

コスト、レイテンシー、回復性の点から最適なホスティングリソースにゲームセッションが配置されるようにマルチフリート、マルチリージョンキューを設定します。

  • CreateGameSessionQueue - ゲームセッション配置のリクエストを処理するときに使用するキューを作成します。

  • DescribeGameSessionQueues – Amazon GameLift Serversリージョンで定義されたゲームセッションキューを取得します。

  • UpdateGameSessionQueue - ゲームセッションキューの設定を変更します。

  • DeleteGameSessionQueue - リージョンからゲームセッションキューを削除します。

エイリアスの管理

エイリアスを使用してフリートを表すか、代わりのターミナル送信先を作成します。エイリアスは、ゲームサーバービルドの更新中など、フリート間でゲームアクティビティを移行するときに役立ちます。

  • CreateAlias - 新しいエイリアスを定義し、必要に応じてフリートに割り当てます。

  • ListAliases – Amazon GameLift Serversリージョンで定義されたすべてのフリートエイリアスを取得します。

  • DescribeAlias - 既存のエイリアスに関する情報を取得します。

  • UpdateAlias - エイリアスの設定 (フリートから別のフリートへのリダイレクトなど) を変更します。

  • DeleteAlias - リージョン からエイリアスを削除します。

  • ResolveAlias - 指定されたエイリアスが指すフリート ID を取得します。

マネージドホスティングインスタンスに接続する

フリートの個々のインスタンスに関する情報を表示したり、トラブルシューティングのために指定したフリートインスタンスへのリモートアクセスをリクエストしたりします。

  • DescribeInstances - ID、IP アドレス、ロケーション、ステータスなど、フリート内の各インスタンスに関する情報を取得します。

  • GetInstanceAccess - フリート内の指定されたインスタンスにリモートConnectするために必要なアクセス認証情報をリクエストします。

VPC ピアリング接続のセットアップ

Amazon GameLift Servers ホスティングリソースと他のリソース間の VPC ピアリング接続を作成および管理します AWS 。

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

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

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

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

    • DescribeGameSessionPlacement - 配置リクエストの詳細とステータスを取得します。

    • StopGameSessionPlacement - 配置リクエストをキャンセルします。

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

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

    • CreatePlayerSession - プレイヤーがゲームセッションに参加できるように空きスロットを予約します。

    • CreatePlayerSessions - 複数のプレイヤーがゲームセッションに参加できるように空きスロットを予約します。

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

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

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

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

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

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

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