搜索 IP 封禁规则

1. 接口定位

• 接口名称: 搜索 IP 封禁规则
• 所属域: admin/forbidden/ip
• 业务目标: 按 IP 关键字和限制类型分页检索注册/登录限制规则

2. 请求定义

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

3. 请求参数

Header 参数

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

Body 参数

字段	必填	类型	说明
keyword	否	string	对 ip 做不区分大小写模糊匹配
status	否	int32	限制状态筛选
pagination	是	object	分页参数

status 取值

值	含义	实际过滤条件
0	不限制筛选	不加限制字段过滤
1	两者都不限制	limit_register = false && limit_login = false
2	仅限制登录	limit_register = false && limit_login = true
3	仅限制注册	limit_register = true && limit_login = false
4	包含限制登录	limit_login = true
5	包含限制注册	limit_register = true
6	同时限制登录和注册	limit_register = true && limit_login = true

pagination 字段

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

4. 响应结构

通用响应包裹

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

data 字段

字段	类型	说明
total	uint32	命中的规则总数
forbiddens	array<object>	当前页规则列表

forbiddens 元素字段

字段	类型	说明
ip	string	IP 地址
limitRegister	bool	是否限制注册
limitLogin	bool	是否限制登录
createTime	int64	创建时间，Unix 毫秒时间戳

5. 业务规则

• 仅管理员可以调用。
• keyword 会对 ip 执行 MongoDB $regex 模糊匹配，忽略大小写。
• status 的过滤逻辑直接来自数据库层枚举判断，不是前端约定值。
• 返回数据只来自本地 ip_forbidden 集合，不会附加其他用户或会话信息。

6. 错误码与失败场景

错误码	场景	典型报错
1001	pagination 为空	pagination is empty
1001	pageNumber < 1	pageNumber is invalid
1001	showNumber < 1	showNumber is invalid
-	数据库搜索失败	由数据库层返回原始错误

7. 示例

fetch 请求示例

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

请求示例（JSON）

{
  "keyword": "203.0.113",
  "status": 4,
  "pagination": {
    "pageNumber": 1,
    "showNumber": 20
  }
}

成功响应示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 1,
    "forbiddens": [
      {
        "ip": "203.0.113.8",
        "limitRegister": true,
        "limitLogin": true,
        "createTime": 1767225600000
      }
    ]
  }
}

失败响应示例

{
  "errCode": 1001,
  "errMsg": "ArgsError",
  "errDlt": "pagination is empty"
}

8. 时序流程

1. 中间件校验管理员 token。
2. 校验分页参数。
3. 按 status 生成限制条件，并按 keyword 模糊匹配 ip。
4. 查询当前页记录。
5. 组装 total + forbiddens 返回。

9. 变更记录

• 2026-03-31: 首版发布，基于 IP 限制状态枚举和分页搜索逻辑补全文档。