Skip to main content
POST
设置自定义域名
使用此路由至少需要 Standard 套餐 同一账户可以将一个域名绑定到多个应用(负载均衡):Standard 最多 2 个应用,Pro 最多 5 个,Enterprise 最多 10 个。参见 列出负载均衡器
string
必填
你账户的 API 密钥。你可以在账户设置中找到它。
替换现有自定义域名时,会先在边缘释放此前的主机名,再绑定新的,除非同一账户下的另一应用仍在使用它。无论是绑定还是移除(custom: "@"),都会执行相同的校验:在工作区共享的应用上,调用者需要具备工作区 Administrator 角色或所有者身份。 一个域名同一时间只能被一个账户占用:绑定一个已被其他账户占用的主机名会返回 DOMAIN_ALREADY_EXISTS。要查看你所有应用中配置的全部主机名,请参见 列出域名。绑定完成后,可通过 获取 DNS 记录 获取所需的校验记录。

参数

string
必填
应用的 ID。你可以在应用仪表盘的 URL 中找到它。
string
必填
要绑定的完全限定域名,或使用 @ 移除应用当前的自定义域名。它不能是 Square Cloud 域名(squareweb.appsquarecloud.app……)。

响应

string
指示调用是否成功。成功时为 success,否则为 error
失败时,响应会包含一个错误 code