服务器分配

警告:此处的 API 文档适用于 Clanforge。如果使用 Multiplay Hosting,请参阅 Multiplay Hosting API 文档

返回一个或多个分配的详细信息。

Matchmaker 应轮询此终端来监控所请求分配的状态。建议进行批量轮询时,每次轮询不超过 100 个分配。

https://api.multiplay.co.uk/cfp/v1/server/allocations

方法

内容类型
GETapplication/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>
        }
    ]
}