DescribeDomain - 查询自定义域名详情信息

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

接口说明

  • 此功能面向API提供者

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeDomainRead
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
GroupIdstring

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

927d50c0f2e54b359919923d908bb015
DomainNamestring

自定义域名

api.demo.com

返回参数

名称类型描述示例值
object
CertificatePrivateKeystring

证书私钥

xxx
DomainNamestring

自定义域名

api.demo.com
DomainBindingStatusstring

自定义域名绑定状态,取值:

  • BINDING:正常
  • BOUND:未生效
BINDING
DomainRemarkstring

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

该域名未备案
CertificateIdstring

SSL证书ID,系统自动生成唯一编号

6EF60BEC-0242-43AF-BB20-270359FB54A7
DomainWebSocketStatusstring

使用WebSocket的域名的状态

NORMAL
RequestIdstring

请求唯一标识

6EF60BEC-0242-43AF-BB20-270359FB54A7
CertificateNamestring

SSL证书名称

myCertificate
DomainLegalStatusstring

域名合法状态,取值:

  • NORMAL:正常
  • ABNORMAL:异常,该状态会影响API调用,需尽快解决
NORMAL
GroupIdstring

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

927d50c0f2e54b359919923d908bb015
CertificateBodystring

证书内容

xxx
SubDomainstring

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

xxx-cn-hangzhou.alicloudapi.com
DomainCNAMEStatusstring

域名解析情况,取值:

  • RESOLVED:已解析
  • UNRESOLVED:未解析
RESOLVED

示例

请求示例

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

正常返回示例

JSON格式

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

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>

错误码

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

阿里云首页 API 网关 相关技术圈