CDNCA

开放接口

/v1/security-bans

3 个接口

← 全部分组 · 第一次调用？先看教程：认证、权限、请求与响应、常见失败

方法路径摘要认证
GET/v1/security-bans列出会话租户网站的封禁名单登录会话
POST/v1/security-bans在会话租户网站手工封禁 IP 或网段登录会话
POST/v1/security-bans/{entry_id}/release解除会话租户网站的一条封禁登录会话

契约文件：api/control-security-bans.openapi.yaml

接口详情

GET /v1/security-bans

列出会话租户网站的封禁名单

operationId
listSecurityBans
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：security_policies.read

参数

listSecurityBans 参数
名称位置类型必填说明
site_idquerystring(uuid)否—
client_ipquerystring否An address or a network.
statequerystring: active / released / expired否—
pagequeryinteger否—
limitqueryinteger否—

响应

listSecurityBans 响应
状态码说明
200Newest first.

字段：items: array<Entry> total: integer page: integer limit: integer

400Error.
401Error.
403Error.
404Error.

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。

↑ 回到列表

POST /v1/security-bans

在会话租户网站手工封禁 IP 或网段

operationId
createSecurityBan
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：security_policies.manage

参数

createSecurityBan 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—

请求体

application/json · 必填：是

createSecurityBan 请求体
名称类型必填说明
site_idstring(uuid)是—
client_ipstring是An IPv4 / IPv6 address, or a network IPv4 /8../31, IPv6 /32../127 (nodes with BAN_CIDR).
duration_secondsinteger是—
reasonstring否—

响应

createSecurityBan 响应
状态码说明
201The ban.

字段：id: string(uuid) tenant_scope_id: string(uuid) site_id: string(uuid) site_domain: string client_ip: string source: string: waf / cc / manual / autodefense / market rule_id: string reason: string banned_at: string(date-time) banned_until: string(date-time) created_by: string(uuid) | null(uuid) released_at: string(date-time) | null(date-time) released_by: string(uuid) | null(uuid) state: string: active / released / expired market: null | MarketOrigin delivery: null | Delivery

400Error.
401Error.
403Error.
404Error.
409Error.
422Error.

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表

POST /v1/security-bans/{entry_id}/release

解除会话租户网站的一条封禁

operationId
releaseSecurityBan
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：security_policies.manage

参数

releaseSecurityBan 参数
名称位置类型必填说明
entry_idpathstring(uuid)是—

响应

releaseSecurityBan 响应
状态码说明
200The ban.

字段：id: string(uuid) tenant_scope_id: string(uuid) site_id: string(uuid) site_domain: string client_ip: string source: string: waf / cc / manual / autodefense / market rule_id: string reason: string banned_at: string(date-time) banned_until: string(date-time) created_by: string(uuid) | null(uuid) released_at: string(date-time) | null(date-time) released_by: string(uuid) | null(uuid) state: string: active / released / expired market: null | MarketOrigin delivery: null | Delivery

400Error.
401Error.
403Error.
404Error.
409Error.

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表