All Products
Search

This Product

    Query the domain name

    Document Center
    Product Details

    Query the domain name

    Last Updated: Dec 18, 2017

    Description

    This function is for querying the details about the custom domain name that you have bound, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.

    • This function is intended for API providers.

    Request parameters

    Name Type Required? Description
    Action String Yes Interface name, which is a required parameter; value: DescribeDomain.
    GroupId String Yes API group ID, which is generated by the system and globally unique.
    DomainName String Yes Custom domain name.

    Returned parameters

    Name Type Description
    RequestId String Unique request ID.
    GroupID String API group ID, which is generated by the system and globally unique.
    DomainName String Custom domain name.
    SubDomain String Second-level domain name automatically assigned to the API group.
    CertificateId String Unique SSL certificate ID, which is automatically generated by the system.
    CertificateName String SSL certificate name.
    CertificateBody String Certificate content.
    CertificatePrivateKey String Private key of the certificate.
    DomainBindingStatus String Binding status of the custom domain name; values:
    • BINDING: The domain name is normal.
    • BOUND: The domain name does not take effect.
    DomainCNAMEStatus String Domain name resolution status; values:
    • RESOLVED: The domain name is resolved.
    • UNRESOLVED: The domain name is not resolved.
    DomainLegalStatus String Domain legal status; values:
    • NORMAL: The domain is valid.
    • ABNORMAL: The domain is invalid, and the API is unavailable. You must fix it as soon as possible.
    DomainRemark String Remark of the domain, such as the reason for abnormity.

    Examples

    Request example

    1. https://apigateway.cn-hangzhou.aliyuncs.com/?Action=DescribeDomain
    2. &GroupId=927d50c0f2e54b359919923d908bb015
    3. &DomainName=api.demo.com
    4. &<Public request parameters>

    Response example

    XML format

    1. <DescribeDomainResponse>
    2.     <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>
    3.     <GroupId>927d50c0f2e54b359919923d908bb015</GroupId>  
    4.     <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>
    5.     <DomainName>api.demo.com</DomainName>
    6.     <CertificateId>6EF60BEC-0242-43AF-BB20-270359FB54A7</CertificateId>
    7.     <CertificateName>myCertificate</CertificateName>
    8.     <CertificateBody>..</CertificateBody>
    9.     <CertificatePrivateKey>..</CertificatePrivateKey>
    10.     <DomainBindingStatus>BINDING</DomainBindingStatus>
    11.     <DomainCNAMEStatus>RESOLVED</DomainCNAMEStatus>
    12.     <DomainLegalStatus>ABNORMAL</DomainLegalStatus>
    13.     <DomainRemark>The domain did not put on record</DomainRemark>
    14. </DescribeDomainResponse>

    JSON format

    1.   {
    2.     "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    3.     "GroupId": "927d50c0f2e54b359919923d908bb015",
    4.     "SubDomain": "927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
    5.     "DomainName": "api.demo.com",
    6.     "CertificateId":"6EF60BEC-0242-43AF-BB20-270359FB54A7",
    7.     "CertificateName": "myCertificate",
    8.     "CertificateBody":"..",
    9.     "CertificatePrivateKey":"..",
    10.     "DDomainBindingStatus": "BINDING",
    11.     "DomainCNAMEStatus": "RESOLVED",
    12.     "DomainLegalStatus":"ABNORMAL",
    13.     "DomainRemark":"The domain did not put on record"
    14.   }