封禁用户

1. 接口定位

• 接口名称: 封禁用户
• 所属域: admin/block
• 业务目标: 将指定用户加入封禁列表，记录封禁原因和操作人

2. 请求定义

• Method: POST
• Path: /block/add
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 非幂等；同一用户重复封禁会直接失败

3. 请求参数

Header 参数

字段	必填	类型	说明
operationID	是	string	链路追踪 ID
token	是	string	管理员 token

Body 参数

字段	必填	类型	说明
userID	是	string	被封禁用户 ID
reason	否	string	封禁原因，允许为空

字段约束

• 协议校验要求 userID 不能为空。
• RPC 层会先查询该用户是否已经被封禁；已封禁则直接返回失败。

4. 响应结构

通用响应包裹

字段	类型	说明
errCode	int	错误码，0 表示成功
errMsg	string	错误简述
errDlt	string	错误详情
data	object	业务数据

data 字段

• 本接口成功时返回空对象（无业务字段）。

5. 业务规则

• 仅管理员可以调用。
• 封禁记录会写入：
  • userID
  • reason
  • operatorUserID: 当前管理员用户 ID，从上下文中获取
  • createTime: 当前服务端时间
• 当前接口只写入封禁表，不会在这里直接执行强制下线。

6. 错误码与失败场景

错误码	场景	典型报错
1001	userID 为空	userID is empty
1001	用户已在封禁列表中	user already blocked
-	查询封禁状态失败	由数据库层返回原始错误
-	写入封禁记录失败	由数据库层返回原始错误

7. 示例

fetch 请求示例

fetch("http://localhost:10009/block/add", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440501",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    userID: "1000001234",
    reason: "spam account",
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "userID": "1000001234",
  "reason": "spam account"
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {}
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "user already blocked"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验 userID。
3. 查询该用户是否已存在封禁记录。
4. 组装封禁原因、操作人和创建时间并写入数据库。
5. 返回统一成功响应。

9. 变更记录

• 2026-03-31: 首版发布，基于封禁用户的存在性校验与落库逻辑补全文档。