1. 接口描述
接口请求域名: dnspod.tencentcloudapi.com 。
批量操作中搜索域名
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDomainAndRecordList。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-23。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
AllDomain | 否 | String | 搜索所有域名。AllDomain、GroupIdList、DomainList、DomainIdList 参数传任一个即可。优先级为:AllDomain > GroupIdList > DomainList > DomainIdList。 示例值:yes |
DomainList.N | 否 | Array of String | 要搜索的域名列表。 示例值:["dnspod.cn","dnspod.com"] |
DomainIdList.N | 否 | Array of Integer | 要搜索的域名 ID 列表。 示例值:[72203,72204] |
GroupIdList.N | 否 | Array of Integer | 要搜索的域名分组 ID 列表。 示例值:[9,10] |
RecordType | 否 | String | 记录类型筛选 示例值:A |
SubKeyword | 否 | String | 子域名筛选 示例值:www |
ValueKeyword | 否 | String | 记录值筛选 示例值:192 |
Area | 否 | String | 线路筛选 示例值:默认 |
Remark | 否 | String | 备注筛选 示例值:备注 |
Enabled | 否 | String | 记录状态筛选 1:正常 0:暂停 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DetailList | Array of BatchSearchDomainInfo | 域名列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量操作中搜索域名
批量操作中搜索域名
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainAndRecordList
<公共请求参数>
{
"AllDomain": "yes",
"RecordType": "A",
"SubKeyword": "www",
"ValueKeyword": "192",
"Area": ""
}
输出示例
{
"Response": {
"RequestId": "7d6bfc77-6cba-478d-80bc-278cacf7ab79",
"DetailList": [
{
"DomainId": 12620698,
"Domain": "example.com",
"DomainGrade": "DP_Free",
"RecordList": [
{
"RecordId": 15934040,
"Area": "默认",
"Remark": "",
"TTL": 600,
"RecordType": "A",
"Enabled": 1,
"Weight": 0,
"GroupId": 0,
"SubDomain": "create-with-remark",
"Value": "127.0.0.1",
"MX": 0
},
{
"RecordId": 15934041,
"Area": "默认",
"Remark": "yyyy",
"TTL": 600,
"RecordType": "A",
"Enabled": 1,
"Weight": 0,
"GroupId": 0,
"SubDomain": "create-with-remark",
"Value": "127.0.0.3",
"MX": 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.UnknowError | 操作未响应,请稍后重试。 |
InvalidParameter.BatchRecordRemoveActionError | 批量删除记录任务失败,原因:内部错误。 |
InvalidParameter.DomainIdInvalid | 域名编号不正确。 |
InvalidParameter.DomainInvalid | 域名不正确,请输入主域名,如 dnspod.cn。 |
InvalidParameter.DomainIsAliaser | 此域名是其它域名的别名。 |
InvalidParameter.DomainsEmpty | 没有提交任何域名。 |
InvalidParameterValue.DomainNotExists | 当前域名有误,请返回重新操作。 |
OperationDenied.DomainOwnerAllowedOnly | 仅域名所有者可进行此操作。 |
OperationDenied.NoPermissionToOperateDomain | 当前域名无权限,请返回域名列表。 |
ResourceNotFound.NoDataOfDomain | 域名列表为空。 |