cdnca

开放接口

/v1/admin/security-ip-lists

4 个接口 · 4 个接口支持 API Key

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

方法路径摘要认证
GET/v1/admin/security-ip-listsList named IP listsAPI Key 可调登录会话
POST/v1/admin/security-ip-listsCreate a named IP listAPI Key 可调登录会话
PUT/v1/admin/security-ip-lists/{list_id}Replace a named IP listAPI Key 可调登录会话
DELETE/v1/admin/security-ip-lists/{list_id}Delete a named IP listAPI Key 可调登录会话

契约文件：api/openapi/v1/control.yaml

接口详情

GET /v1/admin/security-ip-lists

List named IP lists

operationId
listAdminSecurityIPLists
认证
  • API Key：请求头 Authorization: CdncaKey <key_id>.<secret>。有效权限是 Key 的范围与所有者当前权限的交集。
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

说明（契约原文）

Requires security_policies.read. Platform identities only: platform lists, which every tenant may reference.

响应

listAdminSecurityIPLists 响应
状态码说明
200Lists ordered own first, then by name.

字段：items: array<SecurityIPList>

401认证失败或会话已失效。
403当前身份没有执行该操作的权限。
500服务内部故障，请求未完成。

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 500 结果未知：先按资源 ID 或列表回读确认，再决定是否用原 Idempotency-Key 重试。

↑ 回到列表

POST /v1/admin/security-ip-lists

Create a named IP list

operationId
createAdminSecurityIPList
认证
  • API Key：请求头 Authorization: CdncaKey <key_id>.<secret>。有效权限是 Key 的范围与所有者当前权限的交集。
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

说明（契约原文）

Requires security_policies.manage. Entries are canonicalized (masked, deduplicated, ordered). Audit security.ip_list.create. At most 200 live lists per scope.

参数

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

请求体

application/json · 必填：是

createAdminSecurityIPList 请求体
名称类型必填说明
namestring是—
descriptionstring否—
entriesarray<string>是—

响应

createAdminSecurityIPList 响应
状态码说明
201Created, or an identical request replayed.

字段：id: string(uuid) name: string description: string entries: array<string> revision: integer platform: boolean updated_at: string(date-time)

400请求体或参数不合法。
401认证失败或会话已失效。
403当前身份没有执行该操作的权限。
409请求的状态与已有资源或幂等记录冲突。
500服务内部故障，请求未完成。

失败时怎么办

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

↑ 回到列表

PUT /v1/admin/security-ip-lists/{list_id}

Replace a named IP list

operationId
updateAdminSecurityIPList
认证
  • API Key：请求头 Authorization: CdncaKey <key_id>.<secret>。有效权限是 Key 的范围与所有者当前权限的交集。
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

说明（契约原文）

Requires security_policies.manage and the current revision. Every tenant whose bound WAF policy references the list is republished automatically (system trigger ip_list). Audit security.ip_list.update.

参数

updateAdminSecurityIPList 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—
list_idpathstring(uuid)是—

请求体

application/json · 必填：是

updateAdminSecurityIPList 请求体
名称类型必填说明
expected_revisioninteger是—
namestring是—
descriptionstring否—
entriesarray<string>是—

响应

updateAdminSecurityIPList 响应
状态码说明
200Replaced (revision + 1), or an identical request replayed.

字段：id: string(uuid) name: string description: string entries: array<string> revision: integer platform: boolean updated_at: string(date-time)

400请求体或参数不合法。
401认证失败或会话已失效。
403当前身份没有执行该操作的权限。
404请求的资源不存在。
409请求的状态与已有资源或幂等记录冲突。
500服务内部故障，请求未完成。

失败时怎么办

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

↑ 回到列表

DELETE /v1/admin/security-ip-lists/{list_id}

Delete a named IP list

operationId
deleteAdminSecurityIPList
认证
  • API Key：请求头 Authorization: CdncaKey <key_id>.<secret>。有效权限是 Key 的范围与所有者当前权限的交集。
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

契约没有单独标注权限码，权限要求见下方说明与 403 响应。

说明（契约原文）

Requires security_policies.manage and the current revision. A list any live policy version references is refused (409 ip_list_in_use). Audit security.ip_list.delete.

参数

deleteAdminSecurityIPList 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—
list_idpathstring(uuid)是—
expected_revisionqueryinteger是—

响应

deleteAdminSecurityIPList 响应
状态码说明
204Deleted.
400请求体或参数不合法。
401认证失败或会话已失效。
403当前身份没有执行该操作的权限。
404请求的资源不存在。
409请求的状态与已有资源或幂等记录冲突。
500服务内部故障，请求未完成。

失败时怎么办

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

↑ 回到列表