删除 IP 封禁规则

1. 接口定位

• 接口名称: 删除 IP 封禁规则
• 所属域: admin/forbidden/ip
• 业务目标: 按 IP 批量删除注册/登录限制规则

2. 请求定义

• Method: POST
• Path: /forbidden/ip/del
• Content-Type: 推荐 application/json
• operationID: 必填，请通过 Header operationID 传入
• 鉴权: 需要 Header token，且必须是管理员 token
• 幂等性: 弱幂等；空删除结果不会单独报不存在错误

3. 请求参数

Header 参数

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

Body 参数

字段	必填	类型	说明
ips	是	array<string>	要删除的 IP 列表

字段约束

• 协议校验要求 ips 不能为 null。
• 当前 RPC 层不会检查 ips 是否为空数组；数据库层收到空数组时等价于不做删除。

4. 响应结构

通用响应包裹

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

data 字段

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

5. 业务规则

• 仅管理员可以调用。
• 删除条件仅使用 ip in ips。
• 不会先校验目标 IP 是否存在，也不会返回删除数量。

6. 错误码与失败场景

错误码	场景	典型报错
1001	ips 为 null	ips is empty
-	数据库删除失败	由数据库层返回原始错误

7. 示例

fetch 请求示例

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

请求示例（JSON）

{
  "ips": ["203.0.113.8", "198.51.100.20"]
}

成功响应示例

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

失败响应示例

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

8. 时序流程

1. 中间件校验管理员 token。
2. 校验 ips 是否为 null。
3. 按 ip in ips 执行批量删除。
4. 返回统一成功响应。

9. 变更记录

• 2026-03-31: 首版发布，基于 IP 封禁规则删除逻辑补全文档。