调用DescribeDomain查询您绑定的自定义域名详情信息，包含系统自动分配的二级域名、自定义域名和SSL证书信息。

  • 此功能面向API提供者

调试

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

请求参数

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

自定义域名
GroupId String 是 927d50c0f2e54b359919923d908bb015

API分组 ID，系统生成，全局唯一
Action String 否 DescribeDomain

接口名称，系统规定参数，取值：DescribeDomain。

返回数据

名称 类型 示例值 描述
CertificateBody String xxx

证书内容
CertificateId String 6EF60BEC-0242-43AF-BB20-270359FB54A7

SSL证书ID，系统自动生成唯一编号
CertificateName String myCertificate

SSL证书名称
CertificatePrivateKey String xxx

证书私钥
DomainBindingStatus String BINDING

自定义域名绑定状态，取值：

  • BINDING：正常
  • BOUND：未生效
DomainCNAMEStatus String RESOLVED

域名解析情况，取值：

  • RESOLVED：已解析
  • UNRESOLVED：未解析
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

系统为分组分配的二级域名

示例

请求示例


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

正常返回示例

XML 格式 

<DescribeDomainResponse>
      <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>
      <GroupId>927d50c0f2e54b359919923d908bb015</GroupId>  
      <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>
      <DomainName>api.demo.com</DomainName>
      <CertificateId>6EF60BEC-0242-43AF-BB20-270359FB54A7</CertificateId>
      <CertificateName>myCertificate</CertificateName>
      <CertificateBody>..</CertificateBody>
      <CertificatePrivateKey>..</CertificatePrivateKey>
      <DomainBindingStatus>BINDING</DomainBindingStatus>
      <DomainCNAMEStatus>RESOLVED</DomainCNAMEStatus>
      <DomainLegalStatus>ABNORMAL</DomainLegalStatus>
      <DomainRemark>该域名未备案</DomainRemark>
</DescribeDomainResponse>

JSON 格式 

{
	"CertificateName":"myCertificate",
	"DomainLegalStatus":"ABNORMAL",
	"CertificateId":"6EF60BEC-0242-43AF-BB20-270359FB54A7",
	"DomainCNAMEStatus":"RESOLVED",
	"CertificatePrivateKey":"..",
	"SubDomain":"927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
	"CertificateBody":"..",
	"RequestId":"6EF60BEC-0242-43AF-BB20-270359FB54A7",
	"DomainName":"api.demo.com",
	"DDomainBindingStatus":"BINDING",
	"DomainRemark":"该域名未备案",
	"GroupId":"927d50c0f2e54b359919923d908bb015"
}

错误码

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