版本 2.1.1792967583 · 最新 下载 OpenAPI Markdown 版

全局黑白名单

平台级 IP 黑名单与白名单(全网生效),条目可带到期时间、原因与来源,支持批量导入导出;仅管理员可改。

global-ip-lists防护鉴权: 仅管理员4 个接口

获取全局黑白名单

GET/api/v2/global-ip-lists
鉴权: 仅管理员

设置全局黑白名单

PUT/api/v2/global-ip-lists
鉴权: 仅管理员

请求体 application/json

字段类型必填说明
blackstring[]— 黑名单的 IP/CIDR(未过期的全部条目)。
black_itemsIpListItem[]— 黑名单条目(含到期时间、原因、来源)。
expected_updated_atstring— 乐观锁:调用方读到的 updated_at(读到为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
whitestring[]— 白名单的 IP/CIDR(未过期的全部条目)。
white_itemsIpListItem[]— 白名单条目(含到期时间、原因、来源)。

导出全局黑白名单

GET/api/v2/global-ip-lists/export
鉴权: 仅管理员

查询参数

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

批量导入全局黑白名单

POST/api/v2/global-ip-lists/import
鉴权: 仅管理员

请求体 application/json

字段类型必填说明
dry_runboolean— true 只预检,不保存。
默认 false
expected_updated_atstring— 乐观锁:调用方读到的 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[,到期时间][,原因]。

全局黑白名单对象

字段类型必填说明
addedinteger— 新增条数。
appliedboolean— 是否已保存(dry_run 或有挡导入的问题时为 false)。
blackstring[]— 黑名单的 IP/CIDR(未过期的全部条目)。
black_itemsIpListItem[]— 黑名单条目(含到期时间、原因、来源)。
dry_runboolean— true 只预检,不保存。
默认 false
expected_updated_atstring— 乐观锁:调用方读到的 updated_at(读到为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
issuesIpListImportIssue[]— 逐行问题(最多 1000 条,按行号升序)。
linesinteger— 有效条目数(去重后)。
liststring必填 导入到哪张名单。
可选值 ["black","white"]
modestring— merge 并进现有名单(同 IP 以导入行为准);replace 用导入行替换整张名单。
可选值 ["merge","replace"]默认 "merge"
removedinteger— replace 模式下原有、新名单里没有的条数(同 IP 的算「更新」,不算在内)。
textstring必填 文件内容(txt/csv),每行 IP/CIDR[,到期时间][,原因]。
updatedinteger— 已在名单里、被导入行更新的条数。
updated_atstring— 更新时间
只读
whitestring[]— 白名单的 IP/CIDR(未过期的全部条目)。
white_itemsIpListItem[]— 白名单条目(含到期时间、原因、来源)。