1. 接口描述
接口请求域名: dnspod.tencentcloudapi.com 。
批量添加域名
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDomainBatch。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-23。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
DomainList.N | 是 | Array of String | 域名数组 示例值:[dnspod1.cn,dnspod2.cn] |
RecordValue | 否 | String | 每个域名添加 @ 和 www 的 A 记录值,记录值为IP,如果不传此参数或者传空,将只添加域名,不添加记录。 示例值:11.22.33.44 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DetailList | Array of CreateDomainBatchDetail | 批量添加域名信息 |
JobId | Integer | 批量任务的ID 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量添加域名
批量添加域名
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDomainBatch
<公共请求参数>
{
"DomainList": [
"tencent1.com",
"tencent2.com"
],
"RecordValue": "11.22.33.44"
}
输出示例
{
"Response": {
"RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166",
"DetailList": [
{
"RecordList": [
{
"RecordLine": "默认",
"TTL": 600,
"Id": 0,
"SubDomain": "test",
"RecordType": "A",
"Value": "11.22.33.45",
"ErrMsg": null,
"Status": "waiting",
"Operation": "plus"
},
{
"RecordLine": "默认",
"TTL": 600,
"Id": 1,
"SubDomain": "@",
"RecordType": "A",
"Value": "11.22.33.45",
"ErrMsg": null,
"Status": "waiting",
"Operation": "plus"
}
],
"Id": 0,
"Domain": "tencent12.com",
"DomainGrade": "DP_FREE",
"ErrMsg": null,
"Status": "waiting",
"Operation": "plus"
},
{
"RecordList": [
{
"RecordLine": "默认",
"TTL": 600,
"Id": 0,
"SubDomain": "test",
"RecordType": "A",
"Value": "11.22.33.45",
"ErrMsg": null,
"Status": "waiting",
"Operation": "plus"
},
{
"RecordLine": "默认",
"TTL": 600,
"Id": 1,
"SubDomain": "@",
"RecordType": "A",
"Value": "11.22.33.45",
"ErrMsg": null,
"Status": "waiting",
"Operation": "plus"
}
],
"Id": 1,
"Domain": "tencent13.com",
"DomainGrade": "DP_FREE",
"ErrMsg": null,
"Status": "waiting",
"Operation": "plus"
}
],
"JobId": 30
}
}
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.DomainIsLocked | 锁定域名不能进行此操作。 |
FailedOperation.DomainIsSpam | 封禁域名不能进行此操作。 |
InvalidParameter.BatchDomainCreateActionError | 创建批量域名任务失败,原因:内部错误。 |
InvalidParameter.BatchTaskCountLimit | 超过单个账号的批量任务数并发上限4个。 |
InvalidParameter.DomainIdInvalid | 域名编号不正确。 |
InvalidParameter.DomainInvalid | 域名不正确,请输入主域名,如 dnspod.cn。 |
InvalidParameter.DomainIsAliaser | 此域名是其它域名的别名。 |
InvalidParameter.DomainsEmpty | 没有提交任何域名。 |
InvalidParameter.JobGreaterThanLimit | 单次任务记录数量超过上限5000条。 |
InvalidParameter.RecordValueInvalid | 记录的值不正确。 |
InvalidParameter.RecordValueLengthInvalid | 解析记录值过长。 |
InvalidParameter.TooManyInvalidDomains | 当前账号下的无效域名过多,暂时无法使用该功能。请将已有域名的 DNS 服务器正确指向 DNSPod 之后,再尝试添加。 |
InvalidParameterValue.DomainNotExists | 当前域名有误,请返回重新操作。 |
OperationDenied.IPInBlacklistNotAllowed | 抱歉,不允许添加黑名单中的IP。 |
RequestLimitExceeded.BatchTaskLimit | 您的IP添加了过多任务。每个小时内,一个IP最多可提交80个任务,请稍后重试。 |
RequestLimitExceeded.CreateDomainLimit | 您的账号在短时间内添加了大量的域名,请控制添加频率。 |
RequestLimitExceeded.RequestLimitExceeded | API请求次数超出限制。 |