Skip to content

解除封禁用户

1. 接口定位

  • 接口名称: 解除封禁用户
  • 所属域: admin/block
  • 业务目标: 批量将用户从封禁列表中移除

2. 请求定义

  • Method: POST
  • Path: /block/del
  • Content-Type: 推荐 application/json
  • operationID: 必填,请通过 Header operationID 传入
  • 鉴权: 需要 Header token,且必须是管理员 token
  • 幂等性: 非幂等;请求中的每个用户都必须已封禁,否则整体失败

3. 请求参数

Header 参数

字段必填类型说明
operationIDstring链路追踪 ID
tokenstring管理员 token

Body 参数

字段必填类型说明
userIDsarray<string>要解除封禁的用户 ID 列表

字段约束

  • 协议校验要求 userIDs 不能为 null
  • RPC 层要求 userIDs 长度必须大于 0
  • userIDs 中不允许出现重复值。
  • 删除前会校验请求中的每个用户都处于封禁状态,只要缺一个就整体失败。

4. 响应结构

通用响应包裹

字段类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简述
errDltstring错误详情
dataobject业务数据

data 字段

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

5. 业务规则

  • 仅管理员可以调用。
  • 服务端会先查询 userIDs 对应的封禁记录,再比对是否全部存在。
  • 当请求中存在未被封禁的用户时,会返回 user not blocked ...,不会执行部分删除。

6. 错误码与失败场景

错误码场景典型报错
1001userIDsnulluserIDs is empty
1001userIDs 为空数组empty user id
1001userIDs 内存在重复值duplicate user id
1001部分用户未被封禁user not blocked u1, u2
-数据库查询或删除失败由数据库层返回原始错误

7. 示例

fetch 请求示例

javascript
fetch("http://localhost:10009/block/del", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440502",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    userIDs: ["1000001234", "1000005678"],
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例(JSON)

json
{
  "userIDs": ["1000001234", "1000005678"]
}

成功响应示例

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

失败响应示例

json
{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "duplicate user id"
}

8. 时序流程

  1. 中间件校验管理员 token。
  2. 校验 userIDs 是否为空、是否存在重复值。
  3. 查询这些用户的封禁记录。
  4. 校验请求中的每个用户都已被封禁。
  5. 批量删除封禁记录并返回成功响应。

9. 变更记录

  • 2026-03-31: 首版发布,基于解除封禁的全量存在性校验逻辑补全文档。