调用SetDomain给指定分组绑定自定义域名。

  • 此功能面向API提供者。
  • 独立域名在阿里云系统备案成功,请求才能到达您的后端服务。
  • 独立域名要CNAME解析到该分组的二级域名上,后操作绑定。先解析,后绑定,否则绑定操作会报错。
  • 若您需要将其他分组的独立域名变更到当前分组,需要先变更解析,才能成功绑定。
  • 若为https协议,需后续再上传SSL证书,请参见SetDomainCertificate

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
DomainName String api.demo.com

自定义域名

GroupId String 927d50c0f2e54b359919923d908bb015

API分组 ID,系统生成,全局唯一

IsForce String true

在有域名冲突的场景,解绑其他冲突的域名后绑定本域名到分组,主要在以下场景会产生域名冲突的情况:

  • 同用户不同分组下有冲突域名
  • 不同同用户的单域名
AccessKeyId String xxx

您的AccessKey ID

Action String SetDomain

接口名称,系统规定参数,取值:SetDomain

返回数据

名称 类型 示例值 描述
DomainBindingStatus String BINDING

自定义域名绑定状态

  • BINDING:正常
  • BOUND:未生效
DomainLegalStatus String NORMAL

域名合法状态,取值:

  • NORMAL:正常
  • ABNORMAL:异常,该状态会影响API调用,需尽快解决
DomainName String api.demo.com

自定义域名

DomainRemark String

域名相关备注,如描述域名异常状态原因

DomainWebSocketStatus String NORMAL

使用WebSocket功能的域名状态

GroupId String 927d50c0f2e54b359919923d908bb015

API分组 ID,系统生成,全局唯一

RequestId String 6EF60BEC-0242-43AF-BB20-270359FB54A7

请求唯一标识

SubDomain String xxx-cn-hangzhou.alicloudapi.com

系统给分组绑定的二级域名,用于测试API调用

示例

请求示例

  1. http(s)://apigateway.cn-hangzhou.aliyuncs.com/?Action=SetDomain&DomainName=api.demo.com&GroupId=927d50c0f2e54b359919923d908bb015&<公共请求参数>

正常返回示例

XML 格式

  1. <SetDomainResponse> <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId> <GroupId>927d50c0f2e54b359919923d908bb015</GroupId> <DomainName>api.demo.com</DomainName> <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain> <DomainBindingStatus>BINDING</DomainBindingStatus> <DomainLegalStatus>NORMAL</DomainLegalStatus> <DomainRemark></DomainRemark></SetDomainResponse>

JSON 格式

  1. { DomainLegalStatus”:”NORMAL”, DomainBindingStatus”:”BINDING”, SubDomain”:”927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com”, RequestId”:”6EF60BEC-0242-43AF-BB20-270359FB54A7”, DomainName”:”api.abcdef.com”, DomainRemark”:”无”, GroupId”:”927d50c0f2e54b359919923d908bb015”}

错误码

访问错误中心查看更多错误码。

  1. </article>
  2. </main>