/v1/admin/cname-labels

GET /v1/admin/cname-labels/{kind}/{id}

读取管理员自定义的 CNAME 主机名或前缀

operationId

getCNAMELabel

认证

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

所需权限

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

说明（契约原文）

Platform session only; a tenant session answers 403 permission_denied. kind site needs sites.manage, package-subscription package_subscriptions.manage, package-product packages.manage, line-group node_scheduling.manage. site and package-subscription hold a complete host name (shop gives shop.<CNAME domain>); package-product and line-group hold a prefix (gd gives gd-xxxxxxxx.<CNAME domain>, at most 54 characters). Lowercase letters, digits and hyphens, not starting or ending with a hyphen. Errors: cname_label_invalid 400, cname_label_reserved 400, cname_label_taken 409, cname_label_follows_package 409 (a site that follows its sold package).

参数

响应

失败时怎么办

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

↑ 回到列表

PUT /v1/admin/cname-labels/{kind}/{id}

设置管理员自定义的 CNAME 主机名或前缀

operationId

putCNAMELabel

认证

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

所需权限

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

说明（契约原文）

Platform session only; a tenant session answers 403 permission_denied. kind site needs sites.manage, package-subscription package_subscriptions.manage, package-product packages.manage, line-group node_scheduling.manage. site and package-subscription hold a complete host name (shop gives shop.<CNAME domain>); package-product and line-group hold a prefix (gd gives gd-xxxxxxxx.<CNAME domain>, at most 54 characters). Lowercase letters, digits and hyphens, not starting or ending with a hyphen. Errors: cname_label_invalid 400, cname_label_reserved 400, cname_label_taken 409, cname_label_follows_package 409 (a site that follows its sold package). Setting a site or sold package name re-allocates the CNAME of that object at once (a new generation, DNS synchronised, the old record retired). A product or line group prefix only shapes CNAMEs allocated later. An empty label clears the value.

参数

请求体

application/json · 必填：是

响应

失败时怎么办

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

↑ 回到列表

GET /v1/admin/cname-labels/{kind}/{id}/affected

按新前缀重新生成会影响的网站数

operationId

countCNAMELabelAffected

认证

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

所需权限

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

说明（契约原文）

Only for kind package-product and line-group. Sites with their own name, a sold package name or a legacy product host name are not counted.

参数

响应

失败时怎么办

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

↑ 回到列表

POST /v1/admin/cname-labels/{kind}/{id}/regenerate

按新前缀重新生成网站 CNAME

operationId

regenerateCNAMELabelSites

认证

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

所需权限

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

说明（契约原文）

Only for kind package-product and line-group. Read the count with the affected route and confirm first. Sites of one sold package share one new CNAME.

参数

响应

失败时怎么办

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

↑ 回到列表