新增用户登录 IP 限制

1. 接口定位

• 接口名称: 新增用户登录 IP 限制
• 所属域: admin/forbidden/user
• 业务目标: 为指定用户增加允许登录的 IP 约束记录

2. 请求定义

• Method: POST
• Path: /forbidden/user/add
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 非幂等；重复添加相同 userID + ip 组合会因唯一索引失败

3. 请求参数

Header 参数

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

Body 参数

字段	必填	类型	说明
limits	是	array<object>	用户-IP 限制规则列表

limits 元素字段

字段	必填	类型	说明
userID	是	string	用户 ID
ip	是	string	允许登录的 IP

字段约束

• 协议校验要求 limits 不能为 null。
• RPC 层要求 limits 长度必须大于 0。
• 当前实现不会逐项校验 userID 或 ip 是否为空字符串；文档按真实逻辑描述。
• 数据库对 user_id + ip 建有联合唯一索引，重复添加同一组合会失败。

4. 响应结构

通用响应包裹

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

data 字段

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

5. 业务规则

• 仅管理员可以调用。
• 每条记录会落库为：userID + ip + createTime。
• 当前接口名称是“forbidden/user”，但真实业务语义是“限制用户只能从特定 IP 登录”的配置表，而不是账号封禁表。

6. 错误码与失败场景

错误码	场景	典型报错
1001	limits 为 null	limits is empty
1001	limits 为空数组	limits is empty
-	数据库联合唯一索引冲突	由数据库层返回原始错误
-	数据库写入失败	由数据库层返回原始错误

7. 示例

fetch 请求示例

fetch("http://localhost:10009/forbidden/user/add", {
  method: "POST",
  headers: {
    operationID: "550e8400-e29b-41d4-a716-446655440408",
    token: "eyJhbGciOi...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    limits: [
      {
        userID: "1000001234",
        ip: "203.0.113.8",
      },
      {
        userID: "1000001234",
        ip: "198.51.100.20",
      },
    ],
  }),
})
  .then((res) => res.json())
  .then((data) => console.log(data));

请求示例（JSON）

{
  "limits": [
    {
      "userID": "1000001234",
      "ip": "203.0.113.8"
    },
    {
      "userID": "1000001234",
      "ip": "198.51.100.20"
    }
  ]
}

成功响应示例

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

失败响应示例

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

8. 时序流程

1. 中间件校验管理员 token。
2. 校验 limits 是否为空。
3. 将请求列表转换为数据库模型并补充当前服务端时间。
4. 批量写入 limit_user_login_ip 集合。
5. 返回统一成功响应。

9. 变更记录

• 2026-03-31: 首版发布，基于用户登录 IP 限制新增逻辑补全文档。