搜索用户登录 IP 限制

1. 接口定位

• 接口名称: 搜索用户登录 IP 限制
• 所属域: admin/forbidden/user
• 业务目标: 按用户 ID 或 IP 关键字分页检索用户登录 IP 限制，并补充用户公开资料

2. 请求定义

• Method: POST
• Path: /forbidden/user/search
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 幂等

3. 请求参数

Header 参数

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

Body 参数

字段	必填	类型	说明
keyword	否	string	对 user_id 与 ip 做不区分大小写模糊匹配；为空时等价于全量搜索
pagination	是	object	分页参数

pagination 字段

字段	必填	类型	说明
pageNumber	是	int32	页码，从 1 开始
showNumber	是	int32	每页条数，大于 0

4. 响应结构

通用响应包裹

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

data 字段

字段	类型	说明
total	uint32	命中的限制总数
limits	array<object>	当前页限制记录列表

limits 元素字段

字段	类型	说明
userID	string	用户 ID
ip	string	IP 地址
createTime	int64	创建时间，Unix 毫秒时间戳
user	object	用户公开资料

5. 业务规则

• 仅管理员可以调用。
• 数据库搜索使用 $or 同时匹配 user_id 与 ip 两个字段。
• 即使 keyword 为空字符串，数据库层仍会执行空正则匹配，因此效果上等价于全量搜索。
• API 会对当前页中的 userID 去重后调用 chat 服务补充 UserPublicInfo。

6. 错误码与失败场景

错误码	场景	典型报错
1001	pagination 为空	pagination is empty
1001	pageNumber < 1	pageNumber is invalid
1001	showNumber < 1	showNumber is invalid
-	数据库搜索失败	由数据库层返回原始错误
-	用户资料补充失败	由 chat 服务链路返回

7. 示例

fetch 请求示例

fetch("http://localhost:10009/forbidden/user/search", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440410",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    keyword: "1000001234",
    pagination: {
      pageNumber: 1,
      showNumber: 20,
    },
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "keyword": "1000001234",
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  }
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 1,
    "limits": [
      {
        "userID": "1000001234",
        "ip": "203.0.113.8",
        "createTime": 1767225600000,
        "user": {
          "userID": "1000001234",
          "nickname": "alice",
          "faceURL": "https://example.com/avatar.png"
        }
      }
    ]
  }
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "pageNumber is invalid"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验分页参数。
3. 按 keyword 对 user_id 与 ip 分页搜索用户-IP 限制表。
4. 提取当前页用户 ID，去重后调用 chat 服务补充公开资料。
5. 组装 total + limits 返回。

9. 变更记录

• 2026-03-31: 首版发布，基于用户登录 IP 限制搜索和用户资料补充逻辑补全文档。