按条件启动服务器
警告:此处的 API 文档适用于 Clanforge。如果使用 Multiplay Hosting,请参阅 Multiplay Hosting API 文档。
启动通过参数传递的条件所确定的第一个非活跃游戏服务器。
https://api.multiplay.co.uk/cfp/v1/server/start
请求参数#
变量 | 描述 | 可选 |
accountserviceid | 用于过滤服务器的帐户服务 ID | 否 |
gameid | 用于过滤服务器的游戏 ID | 否 |
country_code | 用于过滤服务器的可选国家/地区代码,可在服务器国家/地区终端中查询 | 是 |
locationid | 用于过滤服务器的可选位置 ID | 是 |
响应字段#
字段 | 类型 | 描述 | 可选 |
---|
action | 字符串 | 在服务器上执行的操作。对于此终端,将是“start” | 否 |
success | 布尔值 | 布尔值,指示操作是否成功 | 否 |
server | 对象 | 服务器对象,其中包含服务器的相关信息 | 否 |
服务器对象#
字段 | 类型 | 描述 | 可选 |
---|
serverid | 整数 | 服务器的 ID | 否 |
请求示例#
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/start?accountserviceid=<accountserviceid>&gameid=<gameid>&locationid=1&country_code=<country_code>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'
响应示例#
{
"action": "start",
"success": true,
"server": {
"serverid": <serverid>
}
}