服务器分配
警告:此处的 API 文档适用于 Clanforge。如果使用 Multiplay Hosting,请参阅 Multiplay Hosting API 文档。
返回一个或多个分配的详细信息。
Matchmaker 应轮询此终端来监控所请求分配的状态。建议进行批量轮询时,每次轮询不超过 100 个分配。
https://api.multiplay.co.uk/cfp/v1/server/allocations
方法 | 内容类型 |
GET | application/x-www-form-urlencoded |
请求参数
变量 | 描述 | 可选 |
fleetid | <fleetid> 参数接受分配所属机群的 ID。 | 否 |
uuid | 可以多次提供 <uuid> 参数,每次提供不同的分配 UUID。响应正文包含关于指定分配的信息。指定的所有 UUID 都必须属于同一机群。 | 否 |
响应字段
字段 | 类型 | 描述 | 可选 |
---|---|---|---|
profileid | 整数 | 此服务器所用配置文件的 ID | 否 |
uuid | 字符串 | 分配的 ID | 否 |
regions | 字符串 | 此游戏服务器所在地区的 ID | 否 |
created | 字符串 | 创建分配的时间 | 否 |
requested | 字符串 | 请求分配的时间 | 否 |
fulfilled* | 字符串 | 分配完成的时间 | 否 |
ready* | 字符串 | 分配标记为等待玩家加入的时间 | 是 |
serverid* | 整数 | 此分配的服务器所对应的 ID | 否 |
fleetid | 字符串 | 此服务器所在机群的 ID | 否 |
regionid* | 字符串 | 此服务器所在地区的 ID | 否 |
machineid* | 整数 | 此服务器所在机器的 ID | 否 |
ip* | 字符串 | 此游戏服务器的 IP(版本 4)地址 | 否 |
ipv6* | 字符串 | 此游戏服务器的 IP(版本 6)地址(如果机群支持的话) | 是 |
game_port* | 整数 | 此游戏服务器的网络端口 | 否 |
error | 字符串 | 分配期间发生的任何错误的详细信息 | 是 |
标有 * 的字段可以作为空字符串返回,直到分配过程完成。
请求示例
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/allocations?fleetid=<fleetid>&uuid=<uuid>&uuid=<uuid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'
响应示例
{
"success": true,
"messages": [],
"allocations": [
{
"profileid": <profileid>,
"uuid": <uuid>,
"regions": <regions>,
"created": <created>,
"requested": <requested>,
"fulfilled": <fufilled>,
"serverid": <serverid>,
"fleetid": <fleetid>,
"regionid": <regionid>,
"machineid": <machineid>,
"ip": <ip>,
"ipv6": <ipv6>,
"game_port": <port>,
"error": <error>,
"ready": <status>
}
]
}