cdnca

开放接口

/v1/error-pages

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

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

方法路径摘要认证
GET/v1/error-pages/assetsList error page assetsAPI Key 可调登录会话
POST/v1/error-pages/assets/initiateInitiate a content-addressed assetAPI Key 可调登录会话
GET/v1/error-pages/assets/{asset_id}Get an error page assetAPI Key 可调登录会话
DELETE/v1/error-pages/assets/{asset_id}Mark an unreferenced asset for reconciled deletionAPI Key 可调登录会话
GET/v1/error-pages/assets/{asset_id}/contentRead a ready asset's contentAPI Key 可调登录会话
PUT/v1/error-pages/assets/{asset_id}/contentUpload bounded asset content to stagingAPI Key 可调登录会话
POST/v1/error-pages/assets/{asset_id}/finalizeScan and finalize staged asset contentAPI Key 可调登录会话
GET/v1/error-pages/publication-snapshotRead the latest deterministic publication source snapshotAPI Key 可调登录会话
GET/v1/error-pages/rulesList current error page rule revisionsAPI Key 可调登录会话
POST/v1/error-pages/rulesCreate an append-only error page ruleAPI Key 可调登录会话
GET/v1/error-pages/rules/{rule_id}Get the current rule revisionAPI Key 可调登录会话
PATCH/v1/error-pages/rules/{rule_id}Append an updated rule revisionAPI Key 可调登录会话
DELETE/v1/error-pages/rules/{rule_id}Append a soft-delete rule revisionAPI Key 可调登录会话
POST/v1/error-pages/rules/{rule_id}/disableAppend a disabled rule revisionAPI Key 可调登录会话
POST/v1/error-pages/rules/{rule_id}/enableAppend an enabled rule revisionAPI Key 可调登录会话
GET/v1/error-pages/scope-overridesList current node and region error-page overridesAPI Key 可调登录会话
POST/v1/error-pages/scope-overridesCreate or restore a node or region overrideAPI Key 可调登录会话
GET/v1/error-pages/scope-overrides/{override_display_id}Read an override with verified immutable editor contentAPI Key 可调登录会话
PATCH/v1/error-pages/scope-overrides/{override_display_id}Replace an override item set using compare-and-swapAPI Key 可调登录会话
DELETE/v1/error-pages/scope-overrides/{override_display_id}Append a soft-delete override revisionAPI Key 可调登录会话
GET/v1/error-pages/slotsList the twelve canonical error-page slots in display orderAPI Key 可调登录会话
GET/v1/error-pages/slots/{slot_key}Read a slot binding and its verified immutable contentAPI Key 可调登录会话
PUT/v1/error-pages/slots/{slot_key}Append a slot revision that binds a ready immutable assetAPI Key 可调登录会话
DELETE/v1/error-pages/slots/{slot_key}Append an unbound revision and restore the built-in defaultAPI Key 可调登录会话

契约文件：api/control-error-pages.openapi.yaml

接口详情

GET /v1/error-pages/assets

List error page assets

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

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

参数

listErrorPageAssets 参数
名称位置类型必填说明
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—
scope_idquerystring(uuid)否—
limitqueryinteger否—
cursorquerystring否—
statusquerystring: initiated / staged / scan_failed / finalizing / ready / rejected / delete_pending / deleted / orphaned否—

响应

listErrorPageAssets 响应
状态码说明
200Stable cursor page

字段：items: array<Asset> next_cursor?: string

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表

POST /v1/error-pages/assets/initiate

Initiate a content-addressed asset

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

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

参数

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

请求体

application/json · 必填：是

initiateErrorPageAsset 请求体
名称类型必填说明
scope_idstring(uuid)否Optional for tenant sessions and defaults to their own scope; required for platform sessions.
namestring否Display name (the uploaded file name, or the page category and status); empty for an asset uploaded before names existed. No control characters, no surrounding blanks.
mime_typestring: text/html / text/plain / application/json是—
size_bytesinteger(int64)是—
sha256string是—

响应

initiateErrorPageAsset 响应
状态码说明
201Asset identity created in initiated state

字段：value: Asset replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
409Idempotency, lifecycle, reference, or rule precedence conflict
422Quota, static-content, or malware-scan rejection
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

GET /v1/error-pages/assets/{asset_id}

Get an error page asset

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

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

参数

getErrorPageAsset 参数
名称位置类型必填说明
asset_idpathstring(uuid)是—
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—

响应

getErrorPageAsset 响应
状态码说明
200Asset metadata without storage locators or credentials

字段：id: string(uuid) scope_id: string(uuid) tenant_id?: string(uuid) name: string mime_type: string: text/html / text/plain / application/json size_bytes: integer(int64) sha256: string status: string: initiated / staged / scan_failed / finalizing / ready / rejected / delete_pending / deleted / orphaned scan_status: string: pending / passed / rejected / error revision: integer(int64) created_by: string(uuid) created_at: string(date-time) updated_at: string(date-time) deleted_at?: string(date-time)

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

DELETE /v1/error-pages/assets/{asset_id}

Mark an unreferenced asset for reconciled deletion

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

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

参数

deleteErrorPageAsset 参数
名称位置类型必填说明
asset_idpathstring(uuid)是—
If-Matchheaderstring是Quoted positive decimal rule or asset revision, for example `"3"`.
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

响应

deleteErrorPageAsset 响应
状态码说明
202Database transition committed; object cleanup is pending

字段：value: Asset replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
412Revision compare-and-swap failed
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

GET /v1/error-pages/assets/{asset_id}/content

Read a ready asset's content

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

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

说明（契约原文）

The stored body of a ready asset (error_pages.read), integrity checked against its sha256, so a site's error page can be edited as text (网站编辑 → 错误页面). A staged, scanning, rejected or deleted asset answers 409.

参数

getErrorPageAssetContent 参数
名称位置类型必填说明
asset_idpathstring(uuid)是—
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—

响应

getErrorPageAssetContent 响应
状态码说明
200Asset metadata and its UTF-8 body

字段：asset: Asset content: string

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

PUT /v1/error-pages/assets/{asset_id}/content

Upload bounded asset content to staging

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

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

参数

uploadErrorPageAssetContent 参数
名称位置类型必填说明
asset_idpathstring(uuid)是—
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—
Content-Lengthheaderinteger是—

请求体

text/html, text/plain, application/json · 必填：是

响应

uploadErrorPageAssetContent 响应
状态码说明
200Content validated and staged

字段：value: Asset replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
422Quota, static-content, or malware-scan rejection
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

POST /v1/error-pages/assets/{asset_id}/finalize

Scan and finalize staged asset content

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

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

参数

finalizeErrorPageAsset 参数
名称位置类型必填说明
asset_idpathstring(uuid)是—
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

响应

finalizeErrorPageAsset 响应
状态码说明
200Scanner passed and final object is ready

字段：value: Asset replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
422Quota, static-content, or malware-scan rejection
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

GET /v1/error-pages/publication-snapshot

Read the latest deterministic publication source snapshot

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

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

参数

getErrorPagePublicationSnapshot 参数
名称位置类型必填说明
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—

响应

getErrorPagePublicationSnapshot 响应
状态码说明
200Snapshot plus its control-plane digest and creation time

字段：policy: EdgePolicy snapshot_sha256: string created_at: string(date-time)

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

GET /v1/error-pages/rules

List current error page rule revisions

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

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

参数

listErrorPageRules 参数
名称位置类型必填说明
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—
scope_idquerystring(uuid)否—
site_idquerystring(uuid)否—
enabledqueryboolean否—
limitqueryinteger否—
cursorquerystring否—

响应

listErrorPageRules 响应
状态码说明
200Stable cursor page

字段：items: array<Rule> next_cursor?: string

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表

POST /v1/error-pages/rules

Create an append-only error page rule

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

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

参数

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

请求体

application/json · 必填：是

createErrorPageRule 请求体
名称类型必填说明
targetRuleTarget是—
fieldsRuleFields是—

响应

createErrorPageRule 响应
状态码说明
201Rule revision one and a publication fact were committed

字段：value: Rule replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
422Quota, static-content, or malware-scan rejection
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

GET /v1/error-pages/rules/{rule_id}

Get the current rule revision

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

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

参数

getErrorPageRule 参数
名称位置类型必填说明
rule_idpathstring(uuid)是—
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—

响应

getErrorPageRule 响应
状态码说明
200Current append-only rule projection

字段：id: string(uuid) target: RuleTarget tenant_id?: string(uuid) fields: RuleFields priority: integer revision: integer(int64) deleted: boolean created_by: string(uuid) created_at: string(date-time) updated_at: string(date-time)

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

PATCH /v1/error-pages/rules/{rule_id}

Append an updated rule revision

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

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

参数

updateErrorPageRule 参数
名称位置类型必填说明
rule_idpathstring(uuid)是—
If-Matchheaderstring是Quoted positive decimal rule or asset revision, for example `"3"`.
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

请求体

application/json · 必填：是

updateErrorPageRule 请求体
名称类型必填说明
categorystring: origin_response / edge_route / edge_connect / no_host / unknown_site是unknown_site (global only) is the domain mismatch page: a request for a host no site serves gets it with its one status, 403, 404, 410 or 421 (without a rule the node answers a bare 421). no_host is 400; edge_connect 502-504.
matchStatusSelector是—
asset_idstring(uuid)是—
enabledboolean是—

响应

updateErrorPageRule 响应
状态码说明
200New rule and publication revisions

字段：value: Rule replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
412Revision compare-and-swap failed
422Quota, static-content, or malware-scan rejection
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

DELETE /v1/error-pages/rules/{rule_id}

Append a soft-delete rule revision

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

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

参数

deleteErrorPageRule 参数
名称位置类型必填说明
rule_idpathstring(uuid)是—
If-Matchheaderstring是Quoted positive decimal rule or asset revision, for example `"3"`.
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

响应

deleteErrorPageRule 响应
状态码说明
202Soft-delete revision and publication fact committed

字段：value: Rule replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
412Revision compare-and-swap failed
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

POST /v1/error-pages/rules/{rule_id}/disable

Append a disabled rule revision

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

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

参数

disableErrorPageRule 参数
名称位置类型必填说明
rule_idpathstring(uuid)是—
If-Matchheaderstring是Quoted positive decimal rule or asset revision, for example `"3"`.
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

响应

disableErrorPageRule 响应
状态码说明
200New rule and publication revisions

字段：value: Rule replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
412Revision compare-and-swap failed
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

POST /v1/error-pages/rules/{rule_id}/enable

Append an enabled rule revision

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

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

参数

enableErrorPageRule 参数
名称位置类型必填说明
rule_idpathstring(uuid)是—
If-Matchheaderstring是Quoted positive decimal rule or asset revision, for example `"3"`.
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

响应

enableErrorPageRule 响应
状态码说明
200New rule and publication revisions

字段：value: Rule replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
404Resource is absent or hidden by tenant isolation
409Idempotency, lifecycle, reference, or rule precedence conflict
412Revision compare-and-swap failed
422Quota, static-content, or malware-scan rejection
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

GET /v1/error-pages/scope-overrides

List current node and region error-page overrides

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

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

参数

listErrorPageScopeOverrides 参数
名称位置类型必填说明
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—

响应

listErrorPageScopeOverrides 响应
状态码说明
200Active overrides with short display identifiers and no asset UUIDs

字段：items: array<ScopeOverride> total: integer

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表

POST /v1/error-pages/scope-overrides

Create or restore a node or region override

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

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

参数

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

请求体

application/json · 必填：是

createErrorPageScopeOverride 请求体
名称类型必填说明
targetobject | object是—
itemsarray<ScopeOverrideBindingInput>是—

响应

createErrorPageScopeOverride 响应
状态码说明
201Append-only override revision committed

字段：value: ScopeOverride replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
404Resource is absent or hidden by tenant isolation
405The authenticated path exists but does not support the request method.
409Idempotency, lifecycle, reference, or rule precedence conflict
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

GET /v1/error-pages/scope-overrides/{override_display_id}

Read an override with verified immutable editor content

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

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

参数

getErrorPageScopeOverride 参数
名称位置类型必填说明
override_display_idpathstring是—
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—

响应

getErrorPageScopeOverride 响应
状态码说明
200Override document without asset UUIDs, hashes, receipts, or storage locations

字段：display_id: string target: object | object items: array<ScopeOverrideItem> revision: integer(int64) updated_at: string(date-time) deleted?: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
404Resource is absent or hidden by tenant isolation
405The authenticated path exists but does not support the request method.
409Idempotency, lifecycle, reference, or rule precedence conflict
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

PATCH /v1/error-pages/scope-overrides/{override_display_id}

Replace an override item set using compare-and-swap

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

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

参数

updateErrorPageScopeOverride 参数
名称位置类型必填说明
override_display_idpathstring是—
If-Matchheaderstring是Quoted positive decimal rule or asset revision, for example `"3"`.
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

请求体

application/json · 必填：是

updateErrorPageScopeOverride 请求体
名称类型必填说明
itemsarray<ScopeOverrideBindingInput>是—

响应

updateErrorPageScopeOverride 响应
状态码说明
200New current override revision

字段：value: ScopeOverride replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
404Resource is absent or hidden by tenant isolation
405The authenticated path exists but does not support the request method.
409Idempotency, lifecycle, reference, or rule precedence conflict
412Revision compare-and-swap failed
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

DELETE /v1/error-pages/scope-overrides/{override_display_id}

Append a soft-delete override revision

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

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

参数

deleteErrorPageScopeOverride 参数
名称位置类型必填说明
override_display_idpathstring是—
If-Matchheaderstring是Quoted positive decimal rule or asset revision, for example `"3"`.
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

响应

deleteErrorPageScopeOverride 响应
状态码说明
202Soft-delete revision committed; the target inherits its next available source

字段：value: ScopeOverride replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
404Resource is absent or hidden by tenant isolation
405The authenticated path exists but does not support the request method.
409Idempotency, lifecycle, reference, or rule precedence conflict
412Revision compare-and-swap failed
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

GET /v1/error-pages/slots

List the twelve canonical error-page slots in display order

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

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

参数

listErrorPageSlots 参数
名称位置类型必填说明
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—

响应

listErrorPageSlots 响应
状态码说明
200All canonical slots, including slots that have never been bound

字段：items: array<SlotBinding>

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
405The authenticated path exists but does not support the request method.
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表

GET /v1/error-pages/slots/{slot_key}

Read a slot binding and its verified immutable content

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

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

参数

getErrorPageSlot 参数
名称位置类型必填说明
slot_keypathstring: blacklist / http_400 / http_403 / waf_block / http_502 / http_504 / traffic_exceeded / package_expired / site_locked / domain_unconfigured / node_ip_access / connection_limit是—
X-Request-IDheaderstring否—
X-Trace-IDheaderstring否—

响应

getErrorPageSlot 响应
状态码说明
200Current binding and UTF-8 content; an unbound slot carries the built-in page in effect

字段：binding: SlotBinding content: string source: string: override / builtin delivery: string: theme / fallback / none

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
404Resource is absent or hidden by tenant isolation
405The authenticated path exists but does not support the request method.
409Idempotency, lifecycle, reference, or rule precedence conflict
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

PUT /v1/error-pages/slots/{slot_key}

Append a slot revision that binds a ready immutable asset

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

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

参数

bindErrorPageSlot 参数
名称位置类型必填说明
slot_keypathstring: blacklist / http_400 / http_403 / waf_block / http_502 / http_504 / traffic_exceeded / package_expired / site_locked / domain_unconfigured / node_ip_access / connection_limit是—
If-Matchheaderstring是Quoted non-negative slot revision; use `"0"` for a slot that has never been bound.
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

请求体

application/json · 必填：是

bindErrorPageSlot 请求体
名称类型必填说明
asset_idstring(uuid)是—

响应

bindErrorPageSlot 响应
状态码说明
200Current binding after compare-and-swap

字段：value: SlotBinding replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
404Resource is absent or hidden by tenant isolation
405The authenticated path exists but does not support the request method.
409Idempotency, lifecycle, reference, or rule precedence conflict
412Revision compare-and-swap failed
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表

DELETE /v1/error-pages/slots/{slot_key}

Append an unbound revision and restore the built-in default

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

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

参数

unbindErrorPageSlot 参数
名称位置类型必填说明
slot_keypathstring: blacklist / http_400 / http_403 / waf_block / http_502 / http_504 / traffic_exceeded / package_expired / site_locked / domain_unconfigured / node_ip_access / connection_limit是—
If-Matchheaderstring是Quoted non-negative slot revision; use `"0"` for a slot that has never been bound.
Idempotency-Keyheaderstring是—
X-Request-IDheaderstring是—
X-Trace-IDheaderstring是—

响应

unbindErrorPageSlot 响应
状态码说明
200Current unbound slot revision

字段：value: SlotBinding replayed: boolean

400Malformed or unknown input
401Authentication is absent or invalid
403Stable permission denial
404Resource is absent or hidden by tenant isolation
405The authenticated path exists but does not support the request method.
409Idempotency, lifecycle, reference, or rule precedence conflict
412Revision compare-and-swap failed
503Database, scanner, or content-store dependency is unavailable

失败时怎么办

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

↑ 回到列表