cdnca

开放接口

/v1/control-site

3 个接口

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

方法路径摘要认证
GET/v1/control-site/assets/{sha256}—无需认证
GET/v1/control-site/content—无需认证
GET/v1/control-site/packages—无需认证

契约文件：api/control-site-website.openapi.yaml

接口详情

GET /v1/control-site/assets/{sha256}

operationId
readControlSiteAsset
认证
  • 无需认证。
所需权限

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

说明（契约原文）

An uploaded image, a built-in illustration or a website theme plugin image; immutable, served with a sandboxing CSP.

参数

readControlSiteAsset 参数
名称位置类型必填说明
sha256pathstring是—

响应

readControlSiteAsset 响应
状态码说明
200Image bytes
304Not modified
404Not found

失败时怎么办

  • 404 资源不存在或不属于当前租户。

↑ 回到列表

GET /v1/control-site/content

operationId
readControlSiteContent
认证
  • 无需认证。
所需权限

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

说明（契约原文）

The published website as the active plugin lays it out; {schema, enabled:false} while nothing is published.

响应

readControlSiteContent 响应
状态码说明
200Published view

字段：nav?: array<object> | null actions?: array<Link> | null footer?: object pages?: array<object> | null schema?: const cdnca.control-site/v1 enabled?: boolean layout?: string: jidun / xmf theme?: ThemeView brand?: Brand contact?: Contact

304Not modified
503Unavailable

失败时怎么办

  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表

GET /v1/control-site/packages

operationId
listControlSitePackages
认证
  • 无需认证。
所需权限

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

说明（契约原文）

The platform's purchasable packages for the website's plan blocks (fix-sitepricing): published, enabled, in visible groups and on sale, in package sort order, at most 24. Display fields only (no product ID, CNAME, region or purchase policy); -1 limits mean unlimited, prices are minor units of prices.currency. Empty when none are on sale.

响应

listControlSitePackages 响应
状态码说明
200Package list

字段：items: array<object>

503Unavailable

失败时怎么办

  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表