cdnca

开放接口

/v1/openresty-security

9 个接口

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

方法路径摘要认证
POST/v1/openresty-security/actions/download-cc-image—登录会话
GET/v1/openresty-security/configs/global—登录会话
PATCH/v1/openresty-security/configs/global—登录会话
GET/v1/openresty-security/effective—登录会话
GET/v1/openresty-security/overrides—登录会话
POST/v1/openresty-security/overrides—登录会话
PATCH/v1/openresty-security/overrides/{id}—登录会话
DELETE/v1/openresty-security/overrides/{id}—登录会话
GET/v1/openresty-security/targets—登录会话

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

接口详情

POST /v1/openresty-security/actions/download-cc-image

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

全部需要：openresty_security.manage

参数

queueCCImageDownload 参数
名称位置类型必填说明
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—

响应

queueCCImageDownload 响应
状态码说明
202Durable download_cc_img task queued
401Authentication required
403Permission denied
409Duplicate target or idempotency conflict

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表

GET /v1/openresty-security/configs/global

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

全部需要：openresty_security.read

响应

getGlobalOpenRestySecurityConfig 响应
状态码说明
200Current redacted configuration document

字段：id: string(uuid) scope_type: string: global / region / node scope_id: string scope_label?: string revision: integer config: Config key_configured: boolean updated_at: string(date-time) sources?: object

401Authentication required
403Permission denied

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

PATCH /v1/openresty-security/configs/global

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

全部需要：openresty_security.manage

说明（契约原文）

Applies the smallest auto-save patch. A logical retry must reuse the same Idempotency-Key.

参数

patchGlobalOpenRestySecurityConfig 参数
名称位置类型必填说明
If-Matchheaderstring是—
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—

请求体

application/json · 必填：是

patchGlobalOpenRestySecurityConfig 请求体
名称类型必填说明
patchConfig是—

响应

patchGlobalOpenRestySecurityConfig 响应
状态码说明
200Current redacted configuration document

字段：id: string(uuid) scope_type: string: global / region / node scope_id: string scope_label?: string revision: integer config: Config key_configured: boolean updated_at: string(date-time) sources?: object

400Invalid field, conditional value, range, or relationship
401Authentication required
403Permission denied
409Duplicate target or idempotency conflict
412If-Match revision conflict

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。
  • 412 版本已变：回读最新 ETag 后重新判断，再带新的 If-Match 提交。

↑ 回到列表

GET /v1/openresty-security/effective

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

全部需要：openresty_security.read

说明（契约原文）

Resolves the deterministic node-over-region-over-global configuration.

参数

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

响应

getEffectiveOpenRestySecurityConfig 响应
状态码说明
200Current redacted configuration document

字段：id: string(uuid) scope_type: string: global / region / node scope_id: string scope_label?: string revision: integer config: Config key_configured: boolean updated_at: string(date-time) sources?: object

401Authentication required
403Permission denied
404Target absent or hidden across tenant boundary

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。

↑ 回到列表

GET /v1/openresty-security/overrides

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

全部需要：openresty_security.read

参数

listOpenRestySecurityOverrides 参数
名称位置类型必填说明
scope_typequerystring: region / node否—
queryquerystring否—
pagequeryinteger否—
page_sizequeryinteger否—

响应

listOpenRestySecurityOverrides 响应
状态码说明
200Stable page ordered by update time

字段：items: array<Document> page: integer page_size: integer total: integer

401Authentication required
403Permission denied

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

POST /v1/openresty-security/overrides

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

全部需要：openresty_security.manage

参数

createOpenRestySecurityOverride 参数
名称位置类型必填说明
If-Matchheaderstring是—
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—

请求体

application/json · 必填：是

createOpenRestySecurityOverride 请求体
名称类型必填说明
scope_typestring: region / node是—
scope_idstring是—
configOverrideConfig是Sparse override allowlist of exactly the 24 observed selectable configuration groups.

响应

createOpenRestySecurityOverride 响应
状态码说明
201Current redacted configuration document

字段：id: string(uuid) scope_type: string: global / region / node scope_id: string scope_label?: string revision: integer config: Config key_configured: boolean updated_at: string(date-time) sources?: object

400Invalid field, conditional value, range, or relationship
401Authentication required
403Permission denied
409Duplicate target or idempotency conflict

失败时怎么办

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

↑ 回到列表

PATCH /v1/openresty-security/overrides/{id}

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

全部需要：openresty_security.manage

参数

patchOpenRestySecurityOverride 参数
名称位置类型必填说明
idpathstring(uuid)是—
If-Matchheaderstring是—
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—

请求体

application/json · 必填：是

patchOpenRestySecurityOverride 请求体
名称类型必填说明
patchOverrideConfig是Sparse override allowlist of exactly the 24 observed selectable configuration groups.
removed_fieldsarray<string>否—

响应

patchOpenRestySecurityOverride 响应
状态码说明
200Current redacted configuration document

字段：id: string(uuid) scope_type: string: global / region / node scope_id: string scope_label?: string revision: integer config: Config key_configured: boolean updated_at: string(date-time) sources?: object

400Invalid field, conditional value, range, or relationship
401Authentication required
403Permission denied
404Target absent or hidden across tenant boundary
409Duplicate target or idempotency conflict
412If-Match revision conflict

失败时怎么办

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

↑ 回到列表

DELETE /v1/openresty-security/overrides/{id}

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

全部需要：openresty_security.manage

参数

deleteOpenRestySecurityOverride 参数
名称位置类型必填说明
idpathstring(uuid)是—
If-Matchheaderstring是—
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—

响应

deleteOpenRestySecurityOverride 响应
状态码说明
204Deleted; a replay returns the same result
401Authentication required
403Permission denied
404Target absent or hidden across tenant boundary
412If-Match revision conflict

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 412 版本已变：回读最新 ETag 后重新判断，再带新的 If-Match 提交。

↑ 回到列表

GET /v1/openresty-security/targets

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

全部需要：openresty_security.read

参数

searchOpenRestySecurityTargets 参数
名称位置类型必填说明
scope_typequerystring: region / node是—
queryquerystring否—
pagequeryinteger否—
page_sizequeryinteger否—

响应

searchOpenRestySecurityTargets 响应
状态码说明
200Remote node or distinct-region search results

字段：items: array<Target> page: integer page_size: integer total: integer

401Authentication required
403Permission denied

失败时怎么办

  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表