POST /ban/{player_identifier}
端点: POST /v1/pdapi/ban/<player_identifier>
认证: Bearer 令牌
权限: REST.Punishments.Ban
用途
封禁用户并将记录写入 Banlist.json。如果目标当前在线,可能会被踢出。
路径参数
player_identifier:UserId、PlayerUID或其他受支持的玩家标识符。
查询参数
无。
请求体
可选 JSON 字段:字符串 Reason 和布尔值 IP。只有在同时想封禁解析出的 IP 地址时,才将 IP 设为 true。
响应结构
200 响应架构
| 字段 | 类型 | 描述 |
|---|---|---|
Success |
boolean | 成功记录封禁时为 true。 |
UserId |
string | 被封禁的用户 ID。 |
IP |
boolean | 请求是否同时封禁了 IP 地址。 |
BannedIP |
string | 被封禁的 IP 地址;未封禁 IP 时为空字符串。 |
Kicked |
integer | 此封禁操作踢出的在线玩家数量。 |
错误响应
错误响应使用以下格式:
| HTTP | 错误代码 | 发生条件 |
|---|---|---|
401 |
INVALID_TOKEN |
Authorization 头缺失、格式错误,或与配置的 Bearer 令牌不匹配。 |
403 |
MISSING_PERMISSION |
令牌有效,但不包含此端点权限。 |
400 |
INVALID_JSON |
提供了请求体,但无法解析为 JSON。 |
400 |
REQUEST_FAILED |
游戏线程回调抛出异常,或共享玩家/资源解析器失败。 |
500 |
REQUEST_TIMEOUT |
内部游戏线程回调未在 5 秒内完成。 |
400 |
VALIDATION_FAILED |
可选请求字段的 JSON 类型错误。 |
400 |
IP_UNAVAILABLE |
IP 为 true,但服务器无法解析目标用户的 IP 地址。 |
示例
封禁 Steam 用户
封禁 PS5 用户及其解析出的 IP
使用场景
- 经管理审核后,按
UserId封禁玩家。 - 提供清晰的原因,方便之后的管理人员理解封禁列表条目。
- 使用 GET /banlist 验证活动记录。封禁相关数据不再由
Config.json管理。