Queries the information of a specified domain name.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryDomainByDomainName

The operation that you want to perform. Set the value to QueryDomainByDomainName.

DomainName String Yes example.com

The domain name.

UserClientIp String No 127.0.0.1

The IP address of the client.

Lang String No en

The language in which the system returns the error message. Valid values:

  • zh: Chinese
  • en: English

Default value: en

Response parameters

Parameter Type Example Description
DnsList List dns1.hichina.com,dns2.hichina.com

The Domain Name System (DNS) servers of the domain name.

DomainName String example.com

The domain name.

DomainNameProxyService Boolean false

Indicates whether privacy protection is enabled for the domain name.

DomainNameVerificationStatus String SUCCEED

The status of the naming format verification for the domain name. Valid values:

  • NONAUDIT: The naming format of the domain name is not verified.
  • SUCCEED: The naming format of the domain name is verified.
  • FAILED: The naming format of the domain name fails to be verified.
  • AUDITING: The naming format of the domain name is being verified.
Email String username@example.com

The email address of the domain name registrant.

EmailVerificationClientHold Boolean false

Indicates whether the domain name is in the ClientHold state.

EmailVerificationStatus Integer 1

Indicates whether the email address passes verification. Valid values:

  • 0: The email address fails the verification.
  • 1: The email address passes the verification.
ExpirationDate String 2019-12-07 17:02:13

The time when the domain name expires.

ExpirationDateLong Long 1625111915000

The timestamp when the domain name expires.

InstanceId String S20179H1BBI9****

The instance ID of the domain name.

Premium Boolean false

Indicates whether the domain name is a premium domain name.

RealNameStatus String NONAUDIT

The status of the real-name verification for the domain name. Valid values:

  • NONAUDIT: The real-name verification is not performed.
  • SUCCEED: The real-name verification is performed.
  • FAILED: The real-name verification fails.
  • AUDITING: The real-name verification is in progress.
RegistrantName String Test litm

The name of the contact.

RegistrantOrganization String Test litm

The registrant of the domain name.

RegistrantType String 1

The type of contact who registers the domain name. Valid values:

  • 1: individual
  • 2: enterprise
RegistrantUpdatingStatus String NORMAL

The status of the information of the domain name registrant. Valid values:

  • PENDING: The information of the domain name registrant is being modified.
  • NORMAL: The information of the domain name registrant is not modified.
RegistrationDate String 2017-12-07 17:02:13

The time when the domain name was registered.

RegistrationDateLong Long 1584675448000

The timestamp when the domain name was registered.

RequestId String 44101664-3E70-4F0E-89E5-CCB74BF*****

The ID of the request.

TransferOutStatus String NORMAL

The transfer status of the domain name. Valid values:

  • NORMAL: normal
  • PENDING: being transferred out from Alibaba Cloud
TransferProhibitionLock String CLOSE

The status of the transfer prohibition lock for the domain name. Valid values:

  • NONE_SETTING: No transfer prohibition lock is configured.
  • OPEN: The transfer prohibition lock is enabled.
  • CLOSE: The transfer prohibition lock is disabled.
UpdateProhibitionLock String CLOSE

The status of the update prohibition lock for the domain name. Valid values:

  • NONE_SETTING: No update prohibition lock is configured.
  • OPEN: The update prohibition lock is enabled.
  • CLOSE: The update prohibition lock is disabled.
UserId String 121000000****

The ID of the Alibaba Cloud account.

ZhRegistrantName String Mr. Wang

The Chinese name of the domain name contact.

ZhRegistrantOrganization String Mr. Wang

The Chinese name of the domain name registrant.

Examples

Sample requests

http(s)://[Endpoint]/?Action=QueryDomainByDomainName
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format 

<Email>username@example.com</Email>
<RegistrationDateLong>1584675448000</RegistrationDateLong>
<RegistrationDate>2017-12-07 17:02:13</RegistrationDate>
<RealNameStatus>NONAUDIT</RealNameStatus>
<DomainNameVerificationStatus>SUCCEED</DomainNameVerificationStatus>
<Premium>false</Premium>
<ExpirationDateLong>1625111915000</ExpirationDateLong>
<DnsList>
    <Dns>dns1.hichina.com,dns2.hichina.com</Dns>
</DnsList>
<TransferOutStatus>NORMAL</TransferOutStatus>
<ZhRegistrantOrganization>Mr. Wang</ZhRegistrantOrganization>
<EmailVerificationClientHold>false</EmailVerificationClientHold>
<EmailVerificationStatus>1</EmailVerificationStatus>
<TransferProhibitionLock>CLOSE</TransferProhibitionLock>
<RegistrantOrganization>Test litm</RegistrantOrganization>
<DomainNameProxyService>false</DomainNameProxyService>
<RegistrantType>1</RegistrantType>
<RegistrantUpdatingStatus>NORMAL</RegistrantUpdatingStatus>
<RequestId>44101664-3E70-4F0E-89E5-CCB74BF*****</RequestId>
<InstanceId>S20179H1BBI9****</InstanceId>
<DomainName>example.com</DomainName>
<ZhRegistrantName>Mr. Wang</ZhRegistrantName>
<RegistrantName>Test litm</RegistrantName>
<ExpirationDate>2019-12-07 17:02:13</ExpirationDate>
<UserId>121000000****</UserId>
<UpdateProhibitionLock>CLOSE</UpdateProhibitionLock>

JSON format 

{
    "Email": "username@example.com",
    "RegistrationDateLong": 1584675448000,
    "RegistrationDate": "2017-12-07 17:02:13",
    "RealNameStatus": "NONAUDIT",
    "DomainNameVerificationStatus": "SUCCEED",
    "Premium": false,
    "ExpirationDateLong": 1625111915000,
    "DnsList": {
        "Dns": "dns1.hichina.com,dns2.hichina.com"
    },
    "TransferOutStatus": "NORMAL",
    "ZhRegistrantOrganization": "Mr. Wang",
    "EmailVerificationClientHold": false,
    "EmailVerificationStatus": 1,
    "TransferProhibitionLock": "CLOSE",
    "RegistrantOrganization": "Test litm",
    "DomainNameProxyService": false,
    "RegistrantType": 1,
    "RegistrantUpdatingStatus": "NORMAL",
    "RequestId": "44101664-3E70-4F0E-89E5-CCB74BF*****",
    "InstanceId": "S20179H1BBI9****",
    "DomainName": "example.com",
    "ZhRegistrantName": "Mr. Wang",
    "RegistrantName": "Test litm",
    "ExpirationDate": "2019-12-07 17:02:13",
    "UserId": "121000000****",
    "UpdateProhibitionLock": "CLOSE"
}

Error codes

For a list of error codes, visit the API Error Center.