分配 V2
警告:此处的 API 文档适用于 Clanforge。如果使用 Multiplay Hosting,请参阅 Multiplay Hosting API 文档。
将分配请求排入队列,并可选择在请求正文中设置有效负载。请求完成时,Clanforge 会将反应式扩容系统确定的第一个可用游戏服务器与分配相关联。您可以使用服务器分配调用来查询未完成请求的状态。
https://api.multiplay.co.uk/cfp/v2/fleet/<fleetid>/server/allocate
方法 | 内容类型 |
POST | raw/text/plain |
注意:您可以使用任何能够在请求正文中存储数据的 MIME 类型。例如,文本 (cvs)、图像 (png) 和视频 (mp4) 都是可接受的 MIME 类型。
请求参数
变量 | 描述 | 可选 |
fleetid | <fleetid> 参数接受分配所属机群的 ID。 | 否 |
regionid | <regionid> 参数接受用于分配的地区的 ID。地区 ID 由 Clanforge 提供,并且对您的帐户是唯一的。 | 否 |
profileid | <profileid> 参数接受配置文件 ID。提供的配置文件 ID 将应用于游戏服务器。 | 否 |
uuid | <uuid> 参数接受 UUID,用作分配完成后游戏服务器的分配标识符。这个必须是您生成的有效 UUID。 | 否 |
project_guid | <project_guid> 是项目 ID,用于标识 Unity 项目 GUID(全局唯一标识符)。请参阅设置项目启用 Unity 服务。 | 是(除非使用分配有效负载) |
restart | <restart> 参数接受 true 或 false。如果设为 true,分配将会重启游戏服务器。 | 是 |
响应字段
字段 | 类型 | 描述 | 可选 |
---|---|---|---|
profileid | 整数 | 此服务器所用配置文件的 ID | 否 |
uuid | 字符串 | 分配的 ID | 否 |
regions | 字符串 | 此游戏服务器所在地区的 ID | 否 |
created | 字符串 | 创建分配的时间 | 否 |
requested | 字符串 | 请求分配的时间 | 否 |
ready | 字符串 | 分配标记为等待玩家加入的时间 | 是 |
fleetid | 字符串 | 此服务器所在机群的 ID | 否 |
请求示例
curl --location --request POST 'https://api.multiplay.co.uk/cfp/v2/fleet/<fleetid>/server/allocate?regionid=<regionid>&profileid=<profileid>&uuid=<uuid>&project_guid=<project_guid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'\
--header 'X-Enable-Payload: true' \
--header 'Content-Type: text/plain' \
--data-raw 'This can be anything.'
响应示例
{
"success": true,
"messages": [],
"allocation": {
"profileid": <profileid>,
"uuid": <uuid>,
"regions": <regions>,
"requested": <daterequested>,
"created": <datecreated>,
"fleetid": <fleetid>,
"ready": <status>
}
}