镜像选项
警告: 此处的 API 文档适用于托管游戏服务器 (Clanforge)。如果您使用的是游戏服务器托管 (Multiplay)，请参阅 游戏服务器 API 文档。
获取指定游戏镜像版本的可用镜像选项。
https://api.multiplay.co.uk/cfp/v1/image/options请求参数
方法 |
| GET |
| 变量 | 描述 | 可选 |
| accountserviceid | <accountserviceid> 参数接受与指定资源关联的帐户服务 ID (ASID)。请求标头中的凭据必须具有访问 ASID 的权限才能执行请求。 | 否 |
| gameid | <gameid> 参数接受游戏 ID。提供的游戏 ID 用于筛选响应中的选项。如果您指定 | 是 1 |
| imageid | <imageid> 参数接受游戏镜像 ID。提供的游戏镜像 ID 用于查找安装了指定镜像的机器。如果您指定此参数，则还必须包含 | 是 1 |
| gameversion_identifier | <gameversion_identifier> 参数接受此 mod 有效的游戏版本 ID。如果您指定此参数，则还必须指定 | 是 |
1 如果提供了 <imageid>，则也必须提供 <gameid>，反之亦然。
响应字段
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| diffid | 整数 | 提供的镜像 ID 锁定的差异的 ID | 是 |
| updateid | 整数 | 提供的镜像 ID 锁定的更新的 ID | 是 |
| update_url | 字符串 | 有关镜像更新的信息 | 是 |
| games | 数组 | 可用游戏对象的列表 | 否 |
| images | 数组 | 与提供的游戏 ID 相关的镜像对象的列表 | 否 |
| machines | 数组 | 可作为构建箱使用的机器对象的列表 | 是 |
游戏对象
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| gameid | 整数 | 游戏的 ID | 否 |
| name | 字符串 | 游戏的名称 | 否 |
镜像对象
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| imageid | 整数 | 镜像的 ID | 否 |
| name | 字符串 | 镜像的名称 | 否 |
| gameversionid | 字符串 | 此镜像使用的游戏版本的 ID | 否 |
机器对象
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| machineid | 整数 | 机器的 ID | 否 |
| name | 字符串 | 机器的名称 | 否 |
示例请求
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/image/options?accountserviceid=<accountserviceid>&gameid=<gameid>&imageid=<imageid>&gameversion_identifier=<GameVersionIdentifier>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'示例响应
{
"diffid": <diffid>,
"updateid": <updateid>,
"update_url": <updateurl>,
"games" : [
{
"gameid" : <gameid>,
"name" : <game_name>
},
...
],
"images" : [
{
"imageid" : <imageid>,
"name" : <image_name>,
"gameversionid" : <gameversionid>
},
...
],
"machines" : [
{
"machineid" : <machineid>,
"name" : <machine_name>
},
...
]
}