Queries whether a domain name can be registered.
For more information about how to determine the validity of domain names, see Domain name validity.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CheckDomain |
The operation that you want to perform. Set the value to CheckDomain. |
DomainName | String | Yes | test**.xin |
The domain name that you want to query. |
FeeCommand | String | No | create |
The operation command. Valid values:
|
FeeCurrency | String | No | USD |
The type of the currency. Valid values:
|
FeePeriod | Integer | No | 1 |
The subscription duration of the domain name. Unit: Year. Valid values: 1 to 10. |
Lang | String | No | en |
The language of the error message returned. Valid values:
Default value: en. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Avail | String | 1 |
Indicates whether the domain name can be registered. Valid values:
|
DomainName | String | test**.xin |
The domain name that is queried. |
DynamicCheck | Boolean | true |
Indicates whether the price of the domain name is determined by the domain name registry. Valid values:
|
Premium | String | true |
Indicates whether the domain name is a premium domain name. Valid values:
|
Price | Long | 1286 |
The registration price of a premium domain name. |
Reason | String | In use |
The reason returned by the domain name registry for the domain name that cannot be registered. Note The reasons vary based on domain name registries.
|
RequestId | String | BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1 |
The ID of the request. |
Examples
Sample requests
http(s)://domain.aliyuncs.com/? Action=CheckDomain
&DomainName=test**.xin
&<Common request parameters>
Sample success responses
XML
format
<CheckDomain>
<RequestId>BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1</RequestId>
<DomainName>test**.xin</DomainName>
<Avail>1</Avail>
<Premium>false</Premium>
<Reason></Reason>
<Price>1286</Price>
</CheckDomain>
JSON
format
{
"RequestId": "BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1",
"DomainName": "test**.xin",
"Avail": 1,
"Premium": false,
"Reason": "",
"Price": 1286
}
Error codes
For a list of error codes, visit the API Error Center.