Call CheckDomain to validate a domain name.
Test
You can call this operation directly in OpenAPI Explorer. This eliminates the need to calculate signatures. After a successful call, OpenAPI Explorer automatically generates sample code for the software development kit (SDK).
Request parameters
Name | Type | Required | Example | Description |
DomainId | Integer | Yes | 153345 | The ID of the domain name. |
Action | String | No | CheckDomain | A required parameter. Set the value to CheckDomain. |
Response parameters
Name | Type | Example | Description |
DomainStatus | Integer | 1 | The domain status. This indicates whether the domain is authenticated. 0: Active. The domain is authenticated. 1: Not active. The domain is not authenticated. |
RequestId | String | F0B82E83-A1D9-4FE6-97D2-F4B231F80B02 | The request ID. |
Examples
Request example
http(s)://dm.aliyuncs.com/?Action=CheckDomain
&DomainId=153345
&<Common request parameters>Response examples
XML format
<CheckDomainResponse>
<DomainStatus>1</DomainStatus>
<RequestId>F0B82E83-A1D9-4FE6-97D2-F4B231F80B02</RequestId>
</CheckDomainResponse>JSON format
{
"RequestId":"F0B82E83-A1D9-4FE6-97D2-F4B231F80B02",
"DomainStatus":1
}Error codes
Error code | Description | HTTP status code | Semantics |
InvalidDomainId.Malformed | The specified domain ID does not exist. | 404 | The domain ID does not exist. |
CheckDomain.Failed | Domain check failed. | 400 | The domain validation failed. |
InvalidDomainName.DuplicateTLD | The top-level domain of the specified domain name already exists. | 400 | The primary domain name already exists. |
For more information about error codes, see Error Center.