1. 接口描述
接口请求域名： domain.tencentcloudapi.com 。
检查域名是否可以注册。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CheckDomain。 |
| Version | 是 | String | 公共参数，本接口取值：2018-08-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| DomainName | 是 | String | 所查询域名名称 示例值：domain.com |
| Period | 否 | String | 年限。该参数为空时无法查询溢价词域名 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DomainName | String | 所查询域名名称 示例值：domain.com |
| Available | Boolean | 是否能够注册 示例值：1 |
| Reason | String | 不能注册原因 示例值："" |
| Premium | Boolean | 是否是溢价词 示例值：false |
| Price | Integer | 域名价格 示例值：35 |
| BlackWord | Boolean | 是否是敏感词 示例值：false |
| Describe | String | 溢价词描述 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| FeeRenew | Integer | 溢价词的续费价格 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RealPrice | Integer | 域名真实价格, 溢价词时价格跟年限有关，非溢价词时价格为1年的价格 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| FeeTransfer | Integer | 溢价词的转入价格 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| FeeRestore | Integer | 溢价词的赎回价格 示例值：0 |
| Period | Integer | 检测年限 示例值：1 |
| RecordSupport | Boolean | 是否支持北京备案 true 支持 false 不支持 示例值：true |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 检测域名是否可注册
检测域名是否可注册
输入示例
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckDomain
<公共请求参数>
{
"DomainName": "字符串"
}输出示例
{
"Response": {
"Available": true,
"Premium": false,
"RecordSupport": true,
"DomainName": "的国防生的国防生.show",
"FeeTransfer": 0,
"Describe": "",
"FeeRestore": 0,
"Period": 1,
"Reason": "",
"RequestId": "cc5af1aa-544c-11ea-9bcb-525400f1e866",
"RealPrice": 10,
"BlackWord": false,
"Price": 35,
"FeeRenew": 0
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.CheckDomainFailed | 域名查询失败，请稍后重试该功能。 |
| FailedOperation.GetDomainPriceFailed | 获取域名价格失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DomainNameIsInvalid | 域名输入为空或者不正确。 |
| MissingParameter.DomainIsEmpty | 域名不能为空。 |