服务器状态
警告：此处的 API 文档适用于 Clanforge。如果使用 Multiplay Hosting，请参阅 Multiplay Hosting API 文档。
获取通过 <serverid> 确定的游戏服务器的状态。
https://api.multiplay.co.uk/cfp/v1/server/<serverid>/status方法 |
| GET |
请求参数
| 变量 | 描述 | 可选 |
| serverid | <serverid> 参数接受要检索状态的游戏服务器的游戏服务器 ID。 | 否 |
| query_info | <query_info> 参数让您可以在状态之外请求关于游戏服务器的查询信息。如果设为 如果设为 | 是 |
响应字段
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| active | 整数 | 表示活动状态的数值，其中 0 表示已停止，1 表示已启动，而 >=2 表示正在重启 | 否 |
| allocated_uuid | 字符串 | 此服务器当前所在分配的 UUID，如果无，则为空字符串 | 否 |
| admin_locked | 整数 | 表示锁定状态的数值，其中 1 表示服务器正在进行维护或处于不适合托管游戏会话的状态 | 否 |
| country_code | 字符串 | 两个字母的国家/地区代码，可在服务器国家/地区终端中查询 | 否 |
| game_port | 整数 | 游戏服务器所用的端口 | 否 |
| ip | 字符串 | 游戏服务器所用的 IP 地址 | 否 |
| locationid | 字符串 | 游戏服务器所在位置的 ID | 否 |
| machineid | 整数 | 游戏服务器所在机器的 ID | 否 |
| name | 字符串 | 游戏服务器的名称，这通常是在创建时自动生成的 | 否 |
| profileid | 整数 | 此服务器当前所用配置文件的 ID | 否 |
| query_port | 字符串 | 游戏服务器通过 SQP 等查询协议提供查询信息时应使用的端口 | 否 |
| serverid | 整数 | 服务器的 ID | 否 |
| query_info | 对象 | 针对请求设置了 query_info 时包含额外服务器信息的查询对象 | 是 |
查询对象
查询服务上的所有字段都是在请求时直接从游戏服务器的查询服务返回的。游戏必须支持查询，此功能才能正常工作。
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| players | 整数 | 服务器上的当前玩家数量 | 否 |
| max_players | 整数 | 当前最大匹配玩家数量 | 否 |
| map | 字符串 | 当前地图名称 | 否 |
| status | 字符串 | 当前状态 | 否 |
| name | 字符串 | 当前名称 | 否 |
请求示例
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/<serverid>/status?query_info=<query_info>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'响应示例
{
"server: {
"active: <active>,
"allocated_uuid: <allocated_uuid>,
"admin_locked: <admin_locked>,
"country_code: <country_code>,
"game_port: <game_port>,
"ip: <ip>,
"locationid: <locationid>,
"machineid: <machineid>,
"name: <name>,
"profileid: <profileid>,
"query_port: <query_port>,
"serverid: <serverid>,
"query_info: {
"players: <players>,
"max_players: <max_players>,
"map: <map>,
"status: <status>
"name": <name>
}
}
}