服务器列表 V3
警告：此处的 API 文档适用于 Clanforge。如果使用 Multiplay Hosting，请参阅 Multiplay Hosting API 文档。
获取与通过参数传递的条件相符的所有游戏服务器并以分页列表形式显示。
https://api.multiplay.co.uk/cfp/v3/servers方法 |
| GET |
请求参数
| 变量 | 描述 | 可选 |
| last_id | 上一页 server_id 字段的最后一个值。 | 如果使用分页功能，则必须提供 |
| last_val | 上一页排序列的最后一个值。默认情况下，排序列为 server_id。 | 如果使用分页功能，则必须提供 |
| sort_dir | 结果的排序方向。有效值为 asc（表示升序）和 desc（表示降序）。 | 是 |
| sort_by | 作为排序依据的列。您可以按 serverid、name、profileid 或 machineid 进行排序。默认情况下使用 serverid 进行排序。 | 是 |
| limit | 每页上的结果数量。默认每页显示 100 条。每页最高可显示 1000 条。 | 是 |
响应字段
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| machine_id | 整数 | 此服务器所在机器的 ID | 否 |
| name | 字符串 | 此服务器的名称 | 是 |
| deleted | 字符串 | 显示删除此服务器的日期 | 是 |
| profile_id | 整数 | 此服务器所用配置文件的 ID | 是 |
| server_id | 整数 | 此服务器的 ID | 是 |
请求示例
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v3/servers?sort_by=<sort_by>&sort_dir=<sort_dir>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'以下示例展示了如何获取下一页服务器并按名称倒序排序。在这里，last_id 设为 30，以指示上一页的 ID 为 30，并且 last_val 设为最后一个服务器名称 (svrname)。
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v3/servers?/cfp/v3/servers?sort_by=name&sort_dir=desc&last_id=30&last_val=svrname \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'响应示例
{
data: [
{
"server_id": <server_id>,
"machine_id": <machine_id>,
"name": <server_name>,
"deleted": <deleted_date>,
"profile_id": <profile_id>
},
...
]
}