Amazon GameLift サービス API リファレンス (AWS SDK) - Amazon GameLift
Amazon GameLift ホスティングリソースをセットアップおよび管理するゲームセッションをスタートし、プレイヤーを参加させる

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

Amazon GameLift サービス API リファレンス (AWS SDK)

このトピックでは、カスタム ゲーム サーバーやリアルタイムサーバーのホスティングなど、Amazon GameLift マネージド ホスティングソリューションで使用する API オペレーションのタスクベースの一覧を示します。これらのオペレーションは、aws.gamelift 名前空間の AWS SDK にパッケージ化されています。AWS SDK をダウンロードするか、Amazon GameLift API リファレンスドキュメントをご覧ください。

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

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

Amazon GameLift ホスティングリソースをセットアップおよび管理する

以下のオペレーションを呼び出して、ゲームサーバーのホスティングリソースの設定、プレイヤーの需要に合わせた容量のスケール、パフォーマンスと使用率のメトリクスへのアクセスなどを行います。以下の API オペレーションは、Amazon GameLift でホストされているゲームサーバー (リアルタイムサーバーなど) で使用されます。ほとんどのリソース管理タスクに [Amazon GameLift コンソール] を使用できます。または、AWS Command Line Interface (AWS CLI) ツールまたは AWS SDK を使用してそのサービスを呼び出すことができます。

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

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

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

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

  • [CreateBuild](Create構築) - Amazon S3 バケットに保存されているファイルを使用して新しい構築を作成します。

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

  • [DescribeBuild](Describe構築) - 構築に関連付けられた情報を取得します。

  • [UpdateBuild] ](Update構築)- 構築名とバージョンを含む構築メタデータを変更します。

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

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

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

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

  • [DescribeScript] （説明スクリプト）- リアルタイムスクリプトに関連付けられた情報を取得します。

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

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

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

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

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

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

  • [DescribeEC2InstanceLimits]（作成EC21インスタンス制限） - AWS アカウントと現在の使用レベルで許可されているインスタンスの最大数を取得します。

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

  • [DescribeFleetLocationCapacity]（作成フリートロケーション容量）— マルチロケーション フリートの各ロケーションの現在の容量設定を取得します。

  • [UpdateFleetCapacity]（更新フリート容量）- フリートの容量設定を手動で調整します。

  • Auto Scalingを設定する。

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

    • [DescribeScalingPolicies]（作成スケーリングポリシー） - 既存の Auto Scaling ポリシーを取得します。

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

    • [StartFleetActions]（スタートフリートアクション） - フリートのAuto Scaling ポリシーを再起動します。

    • [StopFleetActions （停止フリートアクション）- フリートの Auto Scaling ポリシーを停止します。

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

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

  • [DescribeFleetLocationUtilization] （作成フリートロケーション活用法）— マルチロケーション フリート内の各ロケーションの使用率統計を取得します。

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

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

ゲームセッションの配置を最適化するためにキューを設定する

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

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

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

  • [UpdateGameSessionQueue] （更新ゲームセッションキュー）— ゲーム セッション キューの設定を変更します。

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

エイリアスの管理

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

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

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

  • [DescribeAlias]（説明エイリアス） - 既存のエイリアスに関する情報を取得します。

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

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

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

ホスティングインスタンスにアクセスする

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

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

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

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] （ゲームセッションログURLの取得）- ゲームセッションのログが保存された場所を取得します。