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

  • 此功能面向API提供者。
  • 独立域名在阿里云系统备案成功,请求才能到达您的后端服务。
  • 独立域名要CNAME解析到该分组的二级域名上,后操作绑定。先解析,后绑定,否则绑定操作会报错。
  • 若您需要将其他分组的独立域名变更到当前分组,需要先变更解析,才能成功绑定。
  • 域名可以单独绑定到某个环境,仅用于某环境的访问。
  • 如果指定了域名为INTRANET类型,则网关(VPC实例)会校验该域名的请求,公网过来的请求会被拒绝。
  • 若为https协议,需后续再上传SSL证书,请参见SetDomainCertificate

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SetDomain

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

DomainName String api.demo.com

自定义域名

GroupId String 927d50c0f2e54b359919923d908bb015

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

BindStageName String RELEASE

域名要指定环境访问。不设置该值,则表示该域名能访问所有环境。

如果指定了某个具体的环境,则该域名只能访问这个环境。

可选值:

  • TEST
  • PRE
  • RELEASE

当要修改为全部环境都可访问时,则将该值设置为空串(“”)即可。

CustomDomainType String INTERNET

指定域名要绑定的类型:公网或者内网。默认为INTERNET。可选值:

  • INTERNET : 公网类型
  • INTRANET : 内网类型, 当指定了内网类型后,就不允许该域名从公网请求过来。
IsForce Boolean false

该字段用于当域名冲突时,是否强制绑定该域名。如果选择true,则会强制在该分组绑定此域名,另外冲突的分组上的域名会自动解绑。该操作有一定风险,请谨慎操作。

返回数据

名称 类型 示例值 描述
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调用

示例

请求示例

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

正常返回示例

XML格式

<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格式

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

错误码

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