版本 2.4.7.20261116085428 · 最新

封禁 bans

被拉黑的 IP 记录,可手动封禁、按 IP 或整站解封并查解封记录,也包含节点上报的自动封禁。

点击任一接口,右侧显示对应的调用示例。

防护鉴权: 用户(部分参数仅管理员)8 个接口

鉴权

请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。

X-API-Key

鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。

约定

分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。

时间一律 RFC 3339(UTC);金额单位为分。

写操作成功回 200/201/204;重复提交按资源唯一键回 409。

GET/api/v2/bans列出封禁

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
ipstring 给单个地址精确匹配;给 CIDR 网段则返回落入该网段的全部封禁(单地址条目,及前缀不短于该网段的网段条目)。
site_idinteger 按站点过滤。
site_idsstring 按网站(多个)过滤:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用;与其他条件取交集。
activeboolean true = 只看未到期的。
levelstring 按作用范围过滤(global = 全局黑名单)。
可选值 ["site","tenant","global"]
sourcestring 按来源过滤:manual = 面板下的(人工);node = 节点自动封的(挑战超限、规则 ban、握手洪水等)。
可选值 ["manual","node"]
source_typestring 按来源细类过滤(manual / cc / waf / scan / status / tls / intel);可逗号分隔多个(如 status,tls,重复的去重),每项都须是这七个值之一,否则 422;不带为全部。
created_fromstring 只看该时刻(含)及之后创建的封禁,用于「今天新增」。同一对象节点再封是续期,不改创建时刻,所以只算首次落库。
POST/api/v2/bans创建封禁

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
tenant_idinteger 仅管理员可用:封禁所属租户。租户级必填;站点级可省(按站主),带了须与站主一致。租户凭据调用时忽略。

请求体 application/json

字段类型说明
expires_atstring 到期时刻;null = 永久。
ip必填string IP 或 CIDR。
level必填string 作用范围:site = 某站点;tenant = 该租户全部站点;global = 全网(仅管理员)。
可选值 ["site","tenant","global"]
reasonstring 原因:人工封禁默认 manual;节点自动封的是触发规则(规则集/规则 id,如 cc.level.r5/r1)或模块名(ssl_handshake = 握手洪水),无规则的记 auto。
site_idinteger level=site 时必填的站点 id;其余为 0。
GET/api/v2/bans/site-counts按站点统计封禁

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
source_typestring 按来源细类过滤(manual / cc / waf / scan / status / tls / intel);可逗号分隔多个(如 status,tls,重复的去重),每项都须是这七个值之一,否则 422;不带为全部。
created_fromstring 只看该时刻(含)及之后创建的封禁,用于「今天新增」。同一对象节点再封是续期,不改创建时刻,所以只算首次落库。
GET/api/v2/bans/source-counts按来源细类统计封禁

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
tenant_idsstring 仅管理员可用:只看这些租户,逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用。只做过滤、不切换请求作用域,与 tenant_id 及其他条件取交集;租户凭据带了非空值回 403。
created_fromstring 只看该时刻(含)及之后创建的封禁,用于「今天新增」。同一对象节点再封是续期,不改创建时刻,所以只算首次落库。
POST/api/v2/bans/unban按 IP 解封

鉴权: 用户(部分参数仅管理员)

请求体 application/json

字段类型说明
allboolean true = 全站解封:清空 site_id 这个站的全部封禁,只用于 level=site,计 1 次每天解封次数。
ipsstring[] 要解封的 IP/CIDR(all=true 时不带,否则必填);一次条数受 protect.unban_batch_max 约束,租户每天次数受 protect.unban_daily_max 约束。
level必填string 作用范围:site = 某站点;tenant = 该租户全部站点;global = 全网(仅管理员)。
可选值 ["site","tenant","global"]
site_idinteger level=site 时必填的站点 id;其余为 0。
GET/api/v2/bans/unban-quota解封配额与今日已用

鉴权: 用户(部分参数仅管理员)

GET/api/v2/bans/unbans列出解封记录

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
site_idinteger 按站点过滤(只含站点级解封)。
site_idsstring 按网站(多个)过滤:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用;与其他条件取交集。
sincestring 只列这个时刻及之后的(如数今天用了几次)。
by_adminboolean 按是否管理员代站主解封过滤;数站主今天用掉的次数传 false(代解不占站主次数)。
DELETE/api/v2/bans/{id}删除封禁

鉴权: 用户(部分参数仅管理员)

封禁对象

字段类型说明
allboolean true = 全站解封:清空 site_id 这个站的全部封禁,只用于 level=site,计 1 次每天解封次数。
batch_maxinteger 一次最多解封几个 IP(配置 protect.unban_batch_max)。
by_adminboolean true = 管理员代站主解封(记在站主名下、站主可见,不占站主每天次数)。
countinteger 未到期封禁条数。
created_atstring 创建时间
只读
daily_maxinteger 租户每天最多解封几次(配置 protect.unban_daily_max)。
expires_atstring 到期时刻;null = 永久。
filter_idstring 触发的过滤器(规则集或模块),由 reason 拆出,如 cc.level.r5、waf、scan.builtin、ssl_handshake;手工封禁与无规则的 auto 不给。
只读
idinteger 记录 ID
只读
intelBanIntel 封禁 IP 在平台高危 IP 库里的现状(列表时按当前库现查;库没在下发、已出库或库没给的字段不返回)。
intel_hitboolean 该 IP 是否在平台高危 IP 库;null = 尚未判定(高危 IP 库上线前恒为 null)。
ipstring IP 或 CIDR。
ip_countinteger 解封的 IP/CIDR 条数(全站解封为 0)。
ipsstring[] 要解封的 IP/CIDR(all=true 时不带,否则必填);一次条数受 protect.unban_batch_max 约束,租户每天次数受 protect.unban_daily_max 约束。
itemsBanSourceCount[] 本页条目
levelstring 作用范围:site = 某站点;tenant = 该租户全部站点;global = 全网(仅管理员)。
可选值 ["site","tenant","global"]
reasonstring 原因:人工封禁默认 manual;节点自动封的是触发规则(规则集/规则 id,如 cc.level.r5/r1)或模块名(ssl_handshake = 握手洪水),无规则的记 auto。
removedinteger 同时从封禁表删除的条数。
rule_idstring 触发的规则号,由 reason 拆出(cc.level.r5/r1 的 r1、waf:941100 的 941100);没有规则号的不给。
只读
site_idinteger level=site 时必填的站点 id;其余为 0。
sourcestring manual = 面板下的;node = 节点自动封后上报的(同一对象未到期时只留一行,再封续期)。解封两者一样:删除或 /bans/unban。
只读可选值 ["manual","node"]
source_typeBanSourceType 来源细类:manual = 面板下的;cc = CC 规则组(含 cc.level.*、cc.user.*、auto 及其余规则集);waf = WAF 规则连续命中;scan = 扫描器内置集;status = 状态码内置集;tls = 握手洪水;intel = 平台高危 IP 库。节点自动封的永不是 manual。
可选值 ["manual","cc","waf","scan","status","tls","intel"]
statusstring 下发任务状态 pending/running/done/failed;任务已被清理为 null。
task_idinteger 下发节点的后台任务 id(GET /tasks/{id} 查进度)。
tenant_idinteger 所属租户;null = 平台对象(内置或管理员建,租户只读)。
只读
updated_atstring 更新时间
只读
usedinteger 本租户今天(UTC 零点起)自己解封的次数;管理员代解不计,管理员调用时为 0。

返回与错误

成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。

成功
{
  "id": 1,
  "name": "example"
}
列表
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
失败
{
  "code": "validation_failed",
  "detail": "请求参数不合法",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name 必填"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
开始使用

123

123