1. 接口描述
接口请求域名： dnspod.tencentcloudapi.com 。
添加域名
备注：该接口不支持添加子域名。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDomain。 |
| Version | 是 | String | 公共参数，本接口取值：2021-03-23。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Domain | 是 | String | 域名 示例值：dnspod.cn |
| GroupId | 否 | Integer | 域名分组ID。可以通过接口DescribeDomainGroupList查看当前域名分组信息 示例值：2 |
| IsMark | 否 | String | 是否星标域名，”yes”、”no” 分别代表是和否。 示例值：no |
| TransferSubDomain | 否 | Boolean | 添加子域名时，是否迁移相关父域名的解析记录。不传默认为 true 示例值：true |
| Tags.N | 否 | Array of TagItem | 域名绑定的标签 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DomainInfo | DomainCreateInfo | 域名信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加域名
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDomain
<公共请求参数>
{
"Domain": "dnspod.com",
"IsMark": "no",
"GroupId": 2
}输出示例
{
"Response": {
"RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166",
"DomainInfo": {
"Id": 62,
"Punycode": "dnspod.com",
"Domain": "dnspod.com",
"GradeNsList": [
"source.dnspod.net",
"low.dnspod.net"
]
}
}
}示例2 CreateDomain_success
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDomain
<公共请求参数>
{
"Domain": "iceice.club"
}输出示例
{
"Response": {
"RequestId": "674a208e-4829-4c2d-a519-a85f2f9bb223",
"DomainInfo": {
"GradeNsList": [
"eunice.dnspod.net",
"country.dnspod.net"
],
"Id": 15,
"Punycode": "iceice.club",
"Domain": "iceice.club"
}
}
}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.DomainExists | 该域名已在您的列表中，无需重复添加。 |
| FailedOperation.DomainInEnterpriseMailAccount | 该域名属于企业邮用户 |
| FailedOperation.DomainOwnedByOtherUser | 该域名已被其他账号添加，可在域名列表中添加取回。 |
| FailedOperation.UnknowError | 操作未响应，请稍后重试。 |
| InvalidParameter.AccountIsBanned | 您的账号已被系统封禁，如果您有任何疑问请与我们联系。 |
| InvalidParameter.DomainInBlackList | 该域名涉及违法违规黑名单，无法进行该操作 |
| InvalidParameter.DomainInvalid | 域名不正确，请输入主域名，如 dnspod.cn。 |
| InvalidParameter.DomainIsAliaser | 此域名是其它域名的别名。 |
| InvalidParameter.DomainIsMyAlias | 此域名是自己域名的别名 |
| InvalidParameter.DomainNotReged | 域名还没有注册，无法添加。 |
| InvalidParameter.EmailNotVerified | 抱歉，您的账户还没有通过邮箱验证。 |
| InvalidParameter.OperateFailed | 操作失败，请稍后再试。 |
| InvalidParameter.QuhuiTxtNotMatch | TXT 记录无法匹配，请确认记录值是否准确，并再次验证。 |
| InvalidParameter.QuhuiTxtRecordWait | TXT 记录未设置或暂未生效，请稍后重试。 |
| InvalidParameter.ToolsDomainInvalid | 域名无效。 |
| InvalidParameter.UnrealNameUser | 未实名认证用户，请先完成实名认证再操作。 |
