Queries the basic information about a domain name based on the instance ID of the domain name.
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | QueryDomainByInstanceId |
The operation that you want to perform. Set the value to QueryDomainByInstanceId. |
InstanceId | String | Yes | S20131205001**** |
The instance ID of the domain name. Note You can call the QueryDomainList operation to query the instance ID of the domain
name. For more information, see QueryDomainList.
|
Lang | String | No | en |
The language in which the system returns the error message. Valid values:
Default value: en. |
UserClientIp | String | No | 127.0.0.1 |
The IP address of the client that is used for the query. Set the value to 127.0.0.1. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DnsList | List | dns1.hichina.com,dns2.hichina.com |
The DNS servers that are configured for the domain name. |
DomainName | String | example.com |
The domain name whose basic information you queried. |
DomainNameProxyService | Boolean | false |
Indicates whether privacy protection is enabled for the domain name. |
DomainNameVerificationStatus | String | NONAUDIT |
The verification status of the naming format of the domain name. Valid values:
|
String | username@example.com |
The email address of the domain name registrant. |
|
EmailVerificationClientHold | Boolean | false |
Indicates whether the resolution of the domain name is suspended. Valid values:
|
EmailVerificationStatus | Integer | 1 |
Indicates whether the email address of the domain name registrant passes the verification. Valid values:
|
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 | S20179H1BBI9test |
The instance ID of the domain name. |
Premium | Boolean | false |
Indicates whether the domain name is a premium domain name. Valid values:
|
RealNameStatus | String | NONAUDIT |
The status of the real-name verification for the domain name. Valid values:
Note A domain name is considered as verified only after both the naming format verification
and real-name verification are successful.
|
RegistrantName | String | Test litm |
The name of the domain name 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:
|
RegistrantUpdatingStatus | String | NORMAL |
The status of the information about the domain name registrant. Valid values:
|
RegistrationDate | String | 2017-12-07 17:02:13 |
The time when the domain name was registered. |
RegistrationDateLong | Long | 1625111915000 |
The timestamp when the domain name was registered. |
RequestId | String | 23C9B3C4-9E2C-4405-A88D-BD33E459D140 |
The ID of the request. |
TransferOutStatus | String | NORMAL |
The transfer status of the domain name. Valid values:
|
TransferProhibitionLock | String | CLOSE |
The status of the transfer lock for the domain name. Valid values:
|
UpdateProhibitionLock | String | CLOSE |
The status of the security lock for the domain name. Valid values:
|
UserId | String | 121000000test |
The ID of the Alibaba Cloud account of the user who uses the domain name. |
ZhRegistrantName | String | Li Si |
The Chinese name of the domain name contact. Note This parameter applies only to the Alibaba Cloud China site (aliyun.com).
|
ZhRegistrantOrganization | String | Li Si |
The Chinese name of the domain name registrant. Note This parameter applies only to the Alibaba Cloud China site (aliyun.com).
|
Examples
Sample requests
http(s)://domain.aliyuncs.com/?Action=QueryDomainByInstanceId
&InstanceId=S20131205001****
&<Common request parameters>
Sample success responses
XML
format
<QueryDomainByInstanceIdResponse>
<RegistrantInfoStatus>NORMAL</RegistrantInfoStatus>
<TransferProhibitionLock>CLOSE</TransferProhibitionLock>
<UpdateProhibitionLock>CLOSE</UpdateProhibitionLock>
<InstanceId>S20179H1BBI9test</InstanceId>
<EmailVerificationStatus>1</EmailVerificationStatus>
<RealNameStatus>NONAUDIT</RealNameStatus>
<DomainNameVerificationStatus>NONAUDIT</DomainNameVerificationStatus>
<UserId>121000000test</UserId>
<Premium>false</Premium>
<ExpirationDate>2019-12-07 17:02:13</ExpirationDate>
<DomainNameProxyService>false</DomainNameProxyService>
<RegistrantType>1</RegistrantType>
<Email>username@example.com</Email>
<RegistrationDate>2017-12-07 17:02:13</RegistrationDate>
<EmailVerificationClientHold>false</EmailVerificationClientHold>
<DomainName>example.com</DomainName>
<TransferOutStatus>NORMAL</TransferOutStatus>
<RegistrantName>Test litm</RegistrantName>
<DnsList>
<Dns>dns1.hichina.com</Dns>
<Dns>dns2.hichina.com</Dns>
</DnsList>
<RegistrantOrganization>Test litm</RegistrantOrganization>
<RequestId>23C9B3C4-9E2C-4405-A88D-BD33E459D140</RequestId>
</QueryDomainByInstanceIdResponse>
JSON
format
{
"requestId": "23C9B3C4-9E2C-4405-A88D-BD33E459D140",
"dnsList": [
"dns1.hichina.com",
"dns2.hichina.com"
],
"domainName": "example.com",
"domainNameProxyService": false,
"email": "username@example.com",
"emailVerificationClientHold": false,
"emailVerificationStatus": 1,
"expirationDate": "2019-12-07 17:02:13",
"instanceId": "S20179H1BBI9test",
"premium": false,
"realNameStatus": "NONAUDIT",
"domainNameVerificationStatus": "NONAUDIT",
"registrantInfoStatus": "NORMAL",
"registrantName": "Test litm",
"registrantOrganization": "Test litm",
"registrationDate": "2017-12-07 17:02:13",
"transferOutStatus": "NORMAL",
"transferProhibitionLock": "CLOSE",
"updateProhibitionLock": "CLOSE",
"userId": "121000000test"
}
Error codes
For a list of error codes, visit the API Error Center.