1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
您可以用过本接口查看站点下的 DNS 记录信息,包括 DNS 记录名、记录类型以及记录内容等信息,支持指定过滤条件查询对应的 DNS 记录信息。
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeDnsRecords。 | 
| Version | 是 | String | 公共参数,本接口取值:2022-09-01。 | 
| Region | 否 | String | 公共参数,此参数为可选参数。 | 
| ZoneId | 是 | String | 站点 ID。 | 
| Offset | 否 | Integer | 分页查询偏移量,默认为 0。 | 
| Limit | 否 | Integer | 分页查询限制数目,默认值:20,上限:1000。 | 
| Filters.N | 否 | Array of AdvancedFilter | 过滤条件,Filters.Values 的上限为20。详细的过滤条件如下: A:将域名指向一个外网 IPv4 地址,如 8.8.8.8; AAAA:将域名指向一个外网 IPv6 地址; CNAME:将域名指向另一个域名,再由该域名解析出最终 IP 地址; TXT:对域名进行标识和说明,常用于域名验证和 SPF 记录(反垃圾邮件); NS:如果需要将子域名交给其他 DNS 服务商解析,则需要添加 NS 记录。根域名无法添加 NS 记录; CAA:指定可为本站点颁发证书的 CA; SRV:标识某台服务器使用了某个服务,常见于微软系统的目录管理; MX:指定收件人邮件服务器。 | 
| SortBy | 否 | String | 排序依据,取值有: | 
| SortOrder | 否 | String | 列表排序方式,取值有: | 
| Match | 否 | String | 匹配方式,取值有: | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| TotalCount | Integer | DNS 记录总数。 | 
| DnsRecords | Array of DnsRecord | DNS 记录列表。 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 查询指定记录 ID 的 DNS 记录列表
在 ZoneId 为 zone-2zo8myp3av8i 的站点下,查询记录 ID 为 record-3277epj0rm2y 的 DNS 记录列表,并且按照记录创建时间进行降序排序。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDnsRecords
<公共请求参数>
{
    "ZoneId": "zone-2zo8myp3av8i",
    "Offset": 0,
    "Limit": 100,
    "Filters": [
        {
            "Fuzzy": false,
            "Values": [
                "record-3277epj0rm2y"
            ],
            "Name": "id"
        }
    ],
    "SortBy": "created-on",
    "SortOrder": "desc"
}输出示例
{
    "Response": {
        "TotalCount": 1,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
        "DnsRecords": [
            {
                "ZoneId": "zone-2zo8myp3av8i",
                "RecordId": "record-3277epj0rm2y",
                "Name": "test.example.com",
                "Type": "A",
                "Location": "Default",
                "Content": "1.1.1.1",
                "TTL": 300,
                "Weight": -1,
                "Priority": 5,
                "Status": "enable",
                "CreatedOn": "2024-09-18T05:03:46Z",
                "ModifiedOn": "2024-09-18T05:03:46Z"
            }
        ]
    }
}示例2 模糊查询指定记录名的 DNS 记录列表
在 ZoneId 为 zone-2zo8myp3av8i 的站点下,模糊查询记录名为 example 的 DNS 记录列表,并且按照记录名进行升序排序。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDnsRecords
<公共请求参数>
{
    "ZoneId": "zone-2zo8myp3av8i",
    "Offset": 0,
    "Limit": 100,
    "Filters": [
        {
            "Fuzzy": true,
            "Values": [
                "example"
            ],
            "Name": "name"
        }
    ],
    "SortBy": "name",
    "SortOrder": "asc"
}输出示例
{
    "Response": {
        "TotalCount": 2,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
        "DnsRecords": [
            {
                "ZoneId": "zone-2zo8myp3av8i",
                "RecordId": "record-3277epj0rm2y",
                "Name": "test.example.com",
                "Type": "A",
                "Location": "Default",
                "Content": "1.1.1.1",
                "TTL": 300,
                "Weight": 40,
                "Priority": 5,
                "Status": "enable",
                "CreatedOn": "2024-09-18T05:03:46Z",
                "ModifiedOn": "2024-09-18T05:03:46Z"
            },
            {
                "ZoneId": "zone-2zo8myp3av8i",
                "RecordId": "record-3277epj0rm2y",
                "Name": "test.example.com",
                "Type": "A",
                "Location": "Default",
                "Content": "2.2.2.2",
                "TTL": 300,
                "Weight": 60,
                "Priority": 5,
                "Status": "enable",
                "CreatedOn": "2024-09-18T05:03:46Z",
                "ModifiedOn": "2024-09-18T05:03:46Z"
            }
        ]
    }
}示例3 查询指定记录类型的 DNS 记录列表
在 ZoneId 为 zone-2zo8myp3av8i 的站点下,查询记录类型为 CNAME 的 DNS 记录列表,并且按照记录内容进行升序排序。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDnsRecords
<公共请求参数>
{
    "ZoneId": "zone-2zo8myp3av8i",
    "Offset": 0,
    "Limit": 100,
    "Filters": [
        {
            "Fuzzy": false,
            "Values": [
                "CNAME"
            ],
            "Name": "type"
        }
    ],
    "SortBy": "content",
    "SortOrder": "asc"
}输出示例
{
    "Response": {
        "TotalCount": 2,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
        "DnsRecords": [
            {
                "ZoneId": "zone-2zo8myp3av8i",
                "RecordId": "record-3277epj0rm2y",
                "Name": "test.example.com",
                "Type": "CNAME",
                "Location": "CN.BJ",
                "Content": "test1.eo.dnse2.com",
                "TTL": 300,
                "Weight": -1,
                "Priority": 0,
                "Status": "enable",
                "CreatedOn": "2024-09-18T05:03:46Z",
                "ModifiedOn": "2024-09-18T05:03:46Z"
            },
            {
                "ZoneId": "zone-2zo8myp3av8i",
                "RecordId": "record-3277epj0rm2y",
                "Name": "test.example.com",
                "Type": "CNAME",
                "Location": "CN.FJ",
                "Content": "test2.eo.dnse2.com",
                "TTL": 300,
                "Weight": -1,
                "Priority": 0,
                "Status": "enable",
                "CreatedOn": "2024-09-18T05:03:46Z",
                "ModifiedOn": "2024-09-18T05:03:46Z"
            }
        ]
    }
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。