机群分配
警告:此处的 API 文档适用于 Clanforge。如果使用 Multiplay Hosting,请参阅 Multiplay Hosting API 文档。
机群分配是一个实用终端,用于查找那些您不再拥有分配 UUID 但尚未超时的分配。
不要将此终端用作 Matchmaker 流程的一部分来监控分配。请改用服务器分配。
https://api.multiplay.co.uk/cfp/v2/fleet/<fleetid>/allocations
方法 |
GET |
请求参数
变量 | 描述 | 可选 |
fleetid | <fleetid> 参数接受分配所属机群的 ID。 | 否 |
age | <age> 参数接受 Golang time.Duration 类型值,该值表示响应中每个分配处于活跃状态的最短时间。例如,如果值为 24h ,则会返回处于活跃状态超过 24 小时的所有分配。 | 否 |
limit | <limit> 参数接受一个整数,用于表示响应中要包含的最大分配数量。<limit> 的值必须在 10 至 50 范围内。默认值为 10 。 | 是 |
empty | <empty> 参数接受布尔值。如果设为 false 或未明确指定,则响应包含空和非空分配。 | 是 |
响应字段
字段 | 类型 | 描述 | 可选 |
---|---|---|---|
profileid | 整数 | 此服务器所用配置文件的 ID | 否 |
uuid | 字符串 | 分配的 ID | 否 |
regions | 字符串 | 此游戏服务器所在地区的 ID | 否 |
created | 字符串 | 创建分配的时间 | 否 |
requested | 字符串 | 请求分配的时间 | 否 |
eta | string | 分配预计会完成的时间 | 否 |
fulfilled | 字符串 | 分配完成的时间 | 否 |
ready | 字符串 | 分配标记为等待玩家加入的时间 | 是 |
serverid | 整数 | 此分配的服务器所对应的 ID | 否 |
fleetid | 字符串 | 此服务器所在机群的 ID | 否 |
regionid | 字符串 | 此服务器所在地区的 ID | 否 |
machineid | 整数 | 此服务器所在机器的 ID | 否 |
ip | 字符串 | 此游戏服务器的 IP(版本 4)地址 | 否 |
ipv6 | 字符串 | 此游戏服务器的 IP(版本 6)地址(如果机群支持的话) | 是 |
game_port | 整数 | 此游戏服务器的网络端口 | 否 |
请求示例
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v2/fleet/<fleetid>/allocations?age=<age>&limit=<limit>&empty=<empty>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'
响应示例
[
{
"profileid": <profileid>,
"uuid": <uuid>,
"requestid": <requestid>,
"regions": <regions>,
"requested": <requested>,
"created": <created>,
"fulfilled": <fulfilled>,
"eta": <eta>,
"serverid": <serverid>,
"fleetid": <fleetid>,
"regionid": <regionid>,
"machineid": <machineid>,
"ip": <ip>,
"ipv6": <ipv6>,
"game_port": <port>,
"ready": <status>
},
...
]