版本 2.4.8 · 最新
区域/节点黑名单 guard-blacklists
按区域或主节点导入的防火墙黑名单文件(每份上限 100 万条),单独成文件下发给节点,不进全局快照。
点击任一接口,右侧显示对应的调用示例。
运维与系统鉴权: 仅管理员4 个接口
鉴权
请求头带 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。
PUT
/api/v2/guard-blacklists/{scope}/{scope_id}导入区域/节点防火墙黑名单
鉴权: 仅管理员
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
allow_broad | boolean | 为 true 时允许过短前缀(IPv4 短于 /8、IPv6 短于 /16);不给或 false 时遇到回 422 broad_prefix,面板二次确认后带 true 重发。 |
区域/节点黑名单对象
| 字段 | 类型 | 说明 |
|---|---|---|
entries | integer | 条数(去重后)。 |
items | GuardBlacklist[] | 本页条目 |
limit | integer | 每份名单的条数上限。 |
name | string | 区域名或主节点名(节点未定名为空)。 |
scope | string | 名单所属的档:region = 区域档;node = 节点档(整份盖掉所在区域档)。 |
scope_id | integer | 区域 id 或主节点 id。 |
sha256 | string | 规范化正文的 sha256(节点按它拉取)。 |
size | integer | 规范化正文字节数。 |
updated_at | string | 导入时间。 |
返回与错误
成功直接回资源 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"
}