版本 2.1.1792967583 · 最新 下载 OpenAPI Markdown 版

站点黑白名单

单个站点的永久 IP 黑名单与白名单;黑名单命中即断开,白名单命中跳过 CC 等防护。也可清空站点在各节点上的临时白名单。

site-ip-lists防护鉴权: 用户（部分参数仅管理员）7 个接口

获取站点黑白名单

GET/api/v2/site-ip-lists/{site_id}
鉴权: 用户（部分参数仅管理员）

设置站点黑白名单

PUT/api/v2/site-ip-lists/{site_id}
鉴权: 用户（部分参数仅管理员）

请求体 application/json

字段类型必填说明
blackstring[]— 永久黑名单(命中 = 断开);条数受 protect.black_ip_max 约束。
black_itemsIpListItem[]— 黑名单条目(含到期时间、原因、来源);已到期的不返回。
expected_updated_atstring— 乐观锁:调用方读到的 updated_at(读到 updated_at 为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
whitestring[]— 永久白名单(命中 = 跳过 CC 等防护);条数受 protect.white_ip_max 约束。
white_itemsIpListItem[]— 白名单条目(含到期时间、原因、来源);已到期的不返回。

导出站点黑白名单

GET/api/v2/site-ip-lists/{site_id}/export
鉴权: 用户（部分参数仅管理员）

查询参数

字段类型必填说明
liststring必填 导出哪张名单。
可选值 ["black","white"]
sourceIpListSource— 只导出该来源的条目;不带为全部。
可选值 ["manual","import","ip_detail","api"]
formatstring— txt(缺省,纯文本每行一条)或 csv(带表头与来源列、UTF-8 BOM)。
可选值 ["txt","csv"]默认 "txt"

批量导入站点黑白名单

POST/api/v2/site-ip-lists/{site_id}/import
鉴权: 用户（部分参数仅管理员）

请求体 application/json

字段类型必填说明
dry_runboolean— true 只预检,不保存。
默认 false
expected_updated_atstring— 乐观锁:调用方读到的 updated_at(读到 updated_at 为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
liststring必填 导入到哪张名单。
可选值 ["black","white"]
modestring— merge 并进现有名单(同 IP 以导入行为准);replace 用导入行替换整张名单。
可选值 ["merge","replace"]默认 "merge"
textstring必填 文件内容(txt/csv),每行 IP/CIDR[,到期时间][,原因]。

IP 详情

GET/api/v2/site-ip-lists/{site_id}/ip-detail
鉴权: 用户（部分参数仅管理员）

查询参数

字段类型必填说明
ipstring必填 IPv4 或 IPv6 地址。

从 IP 详情拉黑或加白

POST/api/v2/site-ip-lists/{site_id}/ip-detail
鉴权: 用户（部分参数仅管理员）

请求体 application/json

字段类型必填说明
expires_atstring— 到期时间;空 = 永久。须晚于当前时刻。
ipstring必填 规范化后的地址(IPv4 映射地址还原成 IPv4)。
liststring必填 导入到哪张名单。
可选值 ["black","white"]
reasonstring— 原因(备注),最长 200 个字符。
scopestring必填 site 本站名单;global 全局名单(仅管理员)。
可选值 ["site","global"]

清空站点临时白名单

POST/api/v2/site-ip-lists/{site_id}/tmp-white-clear
鉴权: 用户（部分参数仅管理员）

站点黑白名单对象

字段类型必填说明
addedinteger— 新增条数。
appliedboolean— 是否已保存(dry_run 或有挡导入的问题时为 false)。
blackstring[]— 永久黑名单(命中 = 断开);条数受 protect.black_ip_max 约束。
black_itemsIpListItem[]— 黑名单条目(含到期时间、原因、来源);已到期的不返回。
block_deniedstring— 不能拉黑的原因:private 内网/回环/链路本地、node 节点 IP(只回管理员)、self 调用者自己的 IP、other 其他原因(租户遇到节点 IP 回这个,不暴露节点地址);能拉黑不回。
可选值 ["private","node","self","other"]
dry_runboolean— true 只预检,不保存。
默认 false
expected_updated_atstring— 乐观锁:调用方读到的 updated_at(读到 updated_at 为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
expires_atstring— 到期时间;空 = 永久。须晚于当前时刻。
geoGeoipLookup— IP 归属地查询结果。
global_blackIpListItem— IP 名单条目(IP 详情里是命中该 IP 的那一条,没命中不回)。
global_whiteIpListItem— IP 名单条目(IP 详情里是命中该 IP 的那一条,没命中不回)。
ipstring— 规范化后的地址(IPv4 映射地址还原成 IPv4)。
issuesIpListImportIssue[]— 逐行问题(最多 1000 条,按行号升序)。
linesinteger— 有效条目数(去重后)。
liststring必填 导入到哪张名单。
可选值 ["black","white"]
modestring— merge 并进现有名单(同 IP 以导入行为准);replace 用导入行替换整张名单。
可选值 ["merge","replace"]默认 "merge"
reasonstring— 原因(备注),最长 200 个字符。
removedinteger— replace 模式下原有、新名单里没有的条数(同 IP 的算「更新」,不算在内)。
scopestring必填 site 本站名单;global 全局名单(仅管理员)。
可选值 ["site","global"]
site_blackIpListItem— IP 名单条目(IP 详情里是命中该 IP 的那一条,没命中不回)。
site_idinteger— 网站 ID
只读
site_whiteIpListItem— IP 名单条目(IP 详情里是命中该 IP 的那一条,没命中不回)。
task_idinteger— 下发节点的后台任务 id(GET /tasks/{id} 查进度)。
textstring必填 文件内容(txt/csv),每行 IP/CIDR[,到期时间][,原因]。
updatedinteger— 已在名单里、被导入行更新的条数。
updated_atstring— 更新时间
只读
whitestring[]— 永久白名单(命中 = 跳过 CC 等防护);条数受 protect.white_ip_max 约束。
white_itemsIpListItem[]— 白名单条目(含到期时间、原因、来源);已到期的不返回。