1. 接口描述
接口请求域名: domain.tencentcloudapi.com 。
查询自定义DNS Host
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCustomDnsHostSet。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
DomainId | 是 | String | 域名实例ID(域名基本信息或我的域名列表接口可获取) 示例值:domain-7312mrgq |
Limit | 是 | Integer | 返回数量,默认为20,取值范围[1,100] 示例值:1 |
Offset | 是 | Integer | 偏移量,默认为0 示例值:20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DnsHostSet | Array of CustomDnsHost | 自定义DNS Host 列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
TotalCount | Integer | 自定义DNS Host总数 示例值:15 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询自定义DNS Host列表
输入示例
POST / HTTP/1.1
Host: domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomDnsHostSet
<公共请求参数>
{
"DomainId": "domain-esysdasdgq",
"Offset": 0,
"Limit": 3
}
输出示例
{
"Response": {
"TotalCount": 2,
"RequestId": "bd4fc5332-23a2-49bd-8cab-48cfe5963651",
"DnsHostSet": [
{
"IpSet": [
"2.2.2.2"
],
"DnsName": "bbbb"
},
{
"IpSet": [
"8.8.9.9",
"3.3.3.3"
],
"DnsName": "aaa"
}
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.CustomDnsNotAllowed | 无权限自定义DNS。 |
MissingParameter.DomainIsEmpty | 域名不能为空。 |
ResourceNotFound.DomainNotFound | 域名地址有误,请输入正确的域名地址。 |