全部产品

绑定自定义域名

更新时间:2017-06-07 13:26:11

描述

给指定分组绑定自定义域名

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

请求参数

名称 类型 是否必须 描述
Action String 接口名称,系统规定参数,取值:SetDomain
GroupId String API分组 ID,系统生成,全局唯一
DomainName String 自定义域名
CertificateName String SSL证书名称
CertificateBody String 证书内容
PrivateKey String 证书私钥

返回参数

名称 类型 描述
RequestId String 请求唯一标识
GroupID String API分组 ID,系统生成,全局唯一
DomainName String 自定义域名
SubDomain String 系统给分组绑定的二级域名,用于测试API调用
DomainBindingStatus String 自定义域名绑定状态
  • BINDING:正常
  • BOUND:未生效
DomainLegalStatus String 域名合法状态,取值:
  • NORMAL:正常
  • ABNORMAL:异常,该状态会影响API调用,需尽快解决
DomainRemark String 域名相关备注,如描述域名异常状态原因

示例

请求示例

  1. https://apigateway.cn-hangzhou.aliyuncs.com/?Action=SetDomain
  2. &GroupId=927d50c0f2e54b359919923d908bb015
  3. &DomainName=api.demo.com
  4. &<公共请求参数>

返回示例

XML格式

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

JSON格式

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