フリートのワークフロー

Follow this workflow to create and manage fleets using the API.

読み終わるまでの所要時間 2 分

最終更新 21日前

注意

注意: このコンテンツはドキュメントのプレビューです。コードサンプルを含む完全なドキュメントは現在作成中です。このページ下部にあるフィードバック方法を利用してフィードバックをお寄せください。

フリートのワークフローは、ビルド設定の取得、フリートの取得 (または作成)、およびフリートの更新をカバーします。ビルドのワークフローを使用する前に、CCD (連続的衝突判定) API キーと以下のロールを持つ UGS サービスアカウントが必要です。

Multiplay API ビューアー
Multiplay API エディター

プロジェクトロールとサービスのアカウント認証を参照してください。

注

このワークフローを通して、使用する Unity プロジェクト ID と環境 ID を参照する必要があります。プロジェクト ID はプロジェクト設定ページ、環境 ID は環境ページで確認できます。

以下の図は、ワークフローの簡略化したバージョンを示しています。

ビルド設定の取得

List build configurations API を使用して、ビルド設定を取得できます。ビルド設定のワークフローを参照してください。

注

ビルド設定 ID を保存してください。ビルド設定 ID がすでにある場合は、フリートの取得に進みます。

以下のコードサンプルは、curl を使用して 既存のビルド設定を取得する 方法を示しています。


curl -X GET \-H "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" \https://services.api.unity.com/multiplay/build-configurations/v1/projects/{projectId}/environments/{environmentId}/build-configurations

レスポンス本体の例とパラメーターのドキュメントについては、List build configurations API のドキュメントを参照してください。

フリートの取得

フリートを取得するプロセスは、既存のフリートを使用するか新規に作成するかによって異なります。既存のフリートを使用するがそれを更新する場合は、フリートの更新を参照してください。

既存のフリートの取得

List fleets API を使用して、フリート ID をその名前で取得できます。フリート ID がすでにわかっていて、フリートを更新する場合は、フリートの更新に進みます。以下のコードサンプルは、curl を使用して 既存のフリートを取得する 方法を示しています。


curl -X GET \-H "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" \https://services.api.unity.com/multiplay/fleets/v1/projects/{projectId}/environments/{environmentId}/fleets

レスポンス本体の例とパラメーターのドキュメントについては、List fleets API のドキュメントを参照してください。

新しいフリートの作成

Create a fleet API を使用して、フリートを作成できます。フリートを作成する場合は、ゲームサーバーを配置する地域を設定する必要があります。List Template Fleet Regions API から、有効な地域 ID を見つけることができます。この API を curl で呼び出すことができます。


curl -X GET \-H "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" \https://services.api.unity.com/multiplay/fleets/v1/projects/{projectId}/environments/{environmentId}/fleets/regions

以下のコードサンプルは、curl を使用して 新しいフリートを作成する 方法を示しています。


curl -X POST \-H "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" \-H "Content-Type: application/json" \-d '{"buildConfigurations": [<BUILD_CONFIG_ID>], "name": "Example Fleet", "osFamily": "LINUX", "osID": "1111a1a1-a11a-11a1-a1a1-1a111aa11111", "regions": [{"maxServers": 10, "minAvailableServers": 10, "regionID": "<REGION_ID>"}]}' \https://services.api.unity.com/multiplay/fleets/v1/projects/{projectId}/environments/{environmentId}/fleets

レスポンス本体の例とパラメーターのドキュメントについては、Create a fleet API のドキュメントを参照してください。

フリートの更新

Update a fleet API を使用して、既存のフリートを更新できます。

注

既存のフリートを使用している場合にのみ、フリートを更新します。新しいフリートを作成している場合は、更新のワークフローを使用する必要はありません。

以下のコードサンプルは、curl を使用して フリートを更新する 方法を示しています。


curl -X PUT \-H "Authorization: Basic <SERVICE_ACCOUNT_CREDENTIALS>" \-H "Content-Type: application/json" \-d '{"buildConfigurations": [<BUILD_CONFIG_ID>], "deleteTTL": 604800, "disabledDeleteTTL": 604800, "name": "Example Fleet", "shutdownTTL": 900}' \https://services.api.unity.com/multiplay/fleets/v1/projects/{projectId}/environments/{environmentId}/fleets/{fleetId}

レスポンス本体の例とパラメーターのドキュメントについては、Update a fleet API のドキュメントを参照してください。

ドキュメント

エンジン

サービス

Grow

産業

サポート

Multiplay Hosting