机群分配

警告:此处的 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> 的值必须在 1050 范围内。默认值为 10
empty<empty> 参数接受布尔值。

如果设为 true,则响应仅包含空分配。

如果设为 false 或未明确指定,则响应包含空和非空分配。

响应字段

字段类型描述可选
profileid整数此服务器所用配置文件的 ID
uuid字符串分配的 ID
regions字符串此游戏服务器所在地区的 ID
created字符串创建分配的时间
requested字符串请求分配的时间
etastring分配预计会完成的时间
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>
    },
    ...
]