文档

支持

Multiplay Hosting

Multiplay Hosting

机群工作流程

Follow this workflow to create and manage fleets using the API.
阅读时间3 分钟最后更新于 15 天前

机群工作流程包括获取版本配置获取(或创建)机群以及更新机群 在使用版本工作流程之前,必须具备 CCD API 密钥和具有以下角色的 UGS 服务帐户:
  • Multiplay API 查看者
  • Multiplay API 编辑者
请参阅项目角色服务帐户身份验证 下图显示了该工作流程的简化版本:
机群工作流程图

机群工作流程图

获取版本配置

可以使用列出版本配置 API 来获取版本配置。请参阅版本配置工作流程 以下代码示例展示了如何使用 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
请参阅列出版本配置 API 文档(了解示例响应体)和参数文档。

获取机群

获取机群的过程取决于您要使用现有机群还是创建新机群。如果您选择使用现有机群但要对其进行更新,请参阅更新机群

获取现有机群

可以使用列出机群 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
请参阅列出机群 API 文档(了解示例响应体)和参数文档。

创建新机群

可以使用创建机群 API 来创建机群。创建机群时,需要配置游戏服务器要放置在哪个地区。通过列出模板机群地区 API 来查找有效的地区 ID。可以使用 curl 调用此 API:
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
请参阅创建机群 API 文档(了解示例响应体)和参数文档。

更新机群

可以使用更新机群 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}
请参阅更新机群 API 文档(了解示例响应体)和参数文档。