1. 接口描述
接口请求域名： dnspod.tencentcloudapi.com 。
获取域名列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDomainList。 |
| Version | 是 | String | 公共参数，本接口取值：2021-03-23。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Type | 否 | String | 域名分组类型，默认为ALL。可取值为ALL，MINE，SHARE，ISMARK，PAUSE，VIP，RECENT，SHARE_OUT，FREE。 示例值：ALL |
| Offset | 否 | Integer | 记录开始的偏移, 第一条记录为 0, 依次类推。默认值为0。 示例值：0 |
| Limit | 否 | Integer | 要获取的域名数量, 比如获取20个, 则为20。默认值为3000。 示例值：20 |
| GroupId | 否 | Integer | 分组ID, 获取指定分组的域名 示例值：1 |
| Keyword | 否 | String | 根据关键字搜索域名 示例值：qq |
| Tags.N | 否 | Array of TagItemFilter | 标签过滤 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DomainCountInfo | DomainCountInfo | 列表页统计信息 |
| DomainList | Array of DomainListItem | 域名列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取域名列表参数示例
获取域名列表
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainList
<公共请求参数>
{
"Type": "ALL",
"Keyword": "dnspod",
"Limit": 1,
"Offset": 0,
"GroupId": 1
}输出示例
{
"Response": {
"DomainCountInfo": {
"AllTotal": 35,
"DomainTotal": 1,
"ErrorTotal": 28,
"GroupTotal": 0,
"LockTotal": 1,
"MineTotal": 28,
"PauseTotal": 1,
"ShareOutTotal": 4,
"ShareTotal": 7,
"SpamTotal": 0,
"VipExpire": 0,
"VipTotal": 4
},
"DomainList": [
{
"CNAMESpeedup": "DISABLE",
"CreatedOn": "2021-05-06 20:40:39",
"DNSStatus": "DNSERROR",
"DomainId": 12614766,
"EffectiveDNS": [
"ns3.dnsv5.com",
"ns4.dnsv5.com"
],
"Grade": "DP_ULTRA",
"GradeLevel": 10,
"GradeTitle": "尊享版",
"GroupId": 1,
"IsVip": "YES",
"Name": "dnspod.com",
"Owner": "qcloud_uin_000000000@qcloud.com",
"Punycode": "dnspod.com",
"RecordCount": 0,
"Remark": "",
"SearchEnginePush": "NO",
"Status": "ENABLE",
"TTL": 600,
"UpdatedOn": "2023-03-09 11:51:56",
"VipAutoRenew": "YES",
"VipEndAt": "2024-01-16 15:56:31",
"VipStartAt": "2023-01-16 15:56:31"
}
],
"RequestId": "bfb3f27e-4dba-4a5c-9aff-08d1c27d1c61"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| FailedOperation.NotRealNamedUser | 未实名认证用户，请先完成实名认证再操作。 |
| FailedOperation.UnknowError | 操作未响应，请稍后重试。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.GroupIdInvalid | 分组编号不正确。 |
| InvalidParameter.OffsetInvalid | 分页起始数量错误。 |
| InvalidParameter.OperateFailed | 操作失败，请稍后再试。 |
| InvalidParameter.ResultMoreThan500 | 搜索结果大于500条，请增加关键字。 |
| InvalidParameterValue.LimitInvalid | 分页长度数量错误。 |
| OperationDenied.AccessDenied | 您没有权限执行此操作。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| RequestLimitExceeded.RequestLimitExceeded | API请求次数超出限制。 |
| UnauthorizedOperation | 未授权操作。 |
