产品公告
Domain name for API request: domain.intl.tencentcloudapi.com.
This API is used to check whether a domain is available for registration.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CheckIntlDomainNew. |
| Version | Yes | String | Common Params. The value used for this API: 2018-08-08. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Domain | Yes | String | The name of the domain to be checked. |
| Period | No | String | Period, in years. If this parameter is left empty, premium domains cannot be queried. |
| Parameter Name | Type | Description |
|---|---|---|
| DomainName | String | The name of the domain checked. |
| Available | Boolean | Whether the domain is available for registration. |
| Reason | String | The reason why the domain cannot be registered. |
| Premium | Boolean | Whether the domain is a premium one. |
| Price | Float | The domain price. |
| BlackWord | Boolean | Whether the domain name involves restricted words. |
| Describe | String | The premium domain description. Note: This field may return null, indicating that no valid values can be obtained. |
| FeeRenew | Float | The price for renewing the premium domain. Note: This field may return null, indicating that no valid values can be obtained. |
| RealPrice | Float | The real price of the domain. For a premium domain, its price varies depending on the period. For a non-premium domain, the price is the 1-year price. Note: This field may return null, indicating that no valid values can be obtained. |
| FeeTransfer | Float | The price for transferring a premium domain in. Note: This field may return null, indicating that no valid values can be obtained. |
| FeeRestore | Float | The price for redeeming a premium domain. |
| Period | Integer | The period (in years) of the domain. |
| ReasonZh | String | The reason why the domain cannot be registered, expressed in Chinese. |
| ResCode | String | The internal error code. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to check whether a domain is available for registration.
POST / HTTP/1.1
Host: domain.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckIntlDomainNew
<Common request parameters>
{
"Domain": "mervyn111.com",
"Period": 1
}{
"Response": {
"Available": true,
"Premium": false,
"DomainName": "Example.show",
"FeeTransfer": 0,
"Describe": "",
"FeeRestore": 0,
"Period": 1,
"Reason": "",
"ReasonZh": "",
"RequestId": "cc5af1aa-544c-11ea-9bcb-525400f1e866",
"RealPrice": 10,
"BlackWord": false,
"Price": 35,
"ResCode": "1002",
"FeeRenew": 0
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.CheckDomainFailed | Domain name query failed. Please try this feature again later. |
| InternalError.CheckDnAvailableErr | Failed to get check data. |
| InternalError.DomainInternalError | Network error. Please try again later. |
| InternalError.ForbiddenRequest | Forbidden request. |
| InternalError.JsonMarshal | Error in converting to JSON. |
| InternalError.MethodNotMatch | Method mismatch. |
| InternalError.NeedLogin | Login is required. |
| InternalError.ReadBodyError | Failed to read the body. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.DomainNameIsInvalid | The domain is empty or incorrect. |
| InvalidParameterValue.InvalidParameterFormat | Invalid parameter value. |
| MissingParameter.ActionNotFound | The route is not defined. |
| MissingParameter.DomainIsEmpty | The domain cannot be empty. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback