DNSPod
旗下子品牌
API 文档
取消
文档目录
记录列表
注意:本页面提供 API 文档为 DNSPod 传统 API ,仅支持 DNSPod Token。仅限主账号调用,子账号不可用。 推荐使用 腾讯云 API 3.0 ,支持 CAM 权限管理,同时支持主账号、子账号调用。兼容腾讯云 API 密钥,提供 API Explorer、API 调用统计等工具,还可以与腾讯云其他产品更好协同使用。
1. 接口描述
本接口 Record.List 用于获取解析记录列表。
接口请求域名:https://dnsapi.cn/Record.List
HTTP请求方式:POST
2. 请求参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
domain_id 或 domain | 是 | Integer 或 String | 分别对应域名ID和域名, 提交其中一个即可。 |
offset | 否 | Integer | 记录开始的偏移,第一条记录为 0,依次类推(仅当指定 length 参数时才生效)。 |
length | 否 | Integer | 共要获取的记录数量的最大值,比如最多获取20条,则为20,最大3000。 |
sub_domain | 否 | String | 子域名,如果指定则只返回此子域名的记录。 |
record_type | 否 | String | 记录类型,通过API记录类型获得,大写英文,比如:A。 |
record_line | 否 | String | 记录线路,通过API记录线路获得,中文,比如:默认。 |
record_line_id | 否 | Integer | 线路的ID,通过API记录线路获得,英文字符串,比如:10=1。 需要获取特定线路的解析记录时,record_line 和 record_line_id 二者传其一即可,系统优先取 record_line_id 。 |
keyword | 否 | String | 搜索的关键字,如果指定则只返回符合该关键字的记录, 指定 keyword 后系统忽略查询参数 sub_domain,record_type,record_line,record_line_id 。 |
3. 响应代码
以下请求参数列表仅列出了此接口请求响应代码,除此接口请求响应代码外。还包含 共通返回。
响应码 | 描述 |
---|---|
6 | 域名ID错误 |
7 | 记录开始的偏移无效、非域名所有者。 |
8 | 共要获取的记录的数量无效、域名无效。 |
13 | 当前域名有误,请返回重新操作。 |
27 | 线路无效。 |
注意:
如果域名的记录数量超过了100,将会强制分页并且只返回前 100 条,这时需要通过 offset 和 length 参数去获取其它记录。
4. 示例
curl -X POST https://dnsapi.cn/Record.List -d 'login_token=LOGIN_TOKEN&format=json&domain_id=12600793&sub_domain=www&record_type=A&offset=0&length=3'
返回示例如下:
- JSON:
{
"status": {
"code": "1",
"message": "Action completed successful",
"created_at": "2018-06-11 10:41:18"
},
"domain": {
"id": "12600793",
"name": "example.com",
"punycode": "example.com",
"grade": "DP_Free",
"owner": "mailbox@example.com",
"ext_status": "dnserror",
"ttl": 600,
"dnspod_ns": [
"ns3.dnsv5.com",
"ns4.dnsv5.com"
]
},
"info": {
"sub_domains": "7",
"record_total": "4",
"records_num": "3"
},
"records": [
{
"id": "13608148",
"name": "www",
"line": "电信",
"line_id": "10=0",
"type": "A",
"ttl": "600",
"value": "1.10.0.3",
"weight": null,
"mx": "0",
"enabled": "1",
"status": "enabled",
"monitor_status": "",
"remark": "",
"updated_on": "2018-06-11 10:12:51",
"use_aqb": "no"
},
{
"id": "13608149",
"name": "www",
"line": "联通",
"line_id": "10=1",
"type": "A",
"ttl": "600",
"value": "1.10.1.3",
"weight": null,
"mx": "0",
"enabled": "1",
"status": "enabled",
"monitor_status": "",
"remark": "",
"updated_on": "2018-06-11 10:13:11",
"use_aqb": "no"
},
{
"id": "13608150",
"name": "www",
"line": "移动",
"line_id": "10=2",
"type": "A",
"ttl": "600",
"value": "1.10.2.3",
"weight": null,
"mx": "0",
"enabled": "1",
"status": "enabled",
"monitor_status": "",
"remark": "",
"updated_on": "2018-06-11 10:14:15",
"use_aqb": "no"
}
]
}
-
字段说明:
-
domain:
- id: 域名ID,即为 domain_id。
- name: 域名。
- punycode: punycode 转码之后的域名。
- grade: 域名等级,详见 Domain.List 或 Domain.Info 接口。
- owner: 域名所有者。
- dnspod_ns: 域名等级对应的ns服务器地址。
-
info:
- sub_domains: 指定域名下所有记录的总数。
- record_total: 指定域名下符合查询条件的记录总数。
- records_num: 返回的 records 列表里的记录数目。
-
records:
- id: 记录ID编号。
- name: 子域名(主机记录)。
- line: 解析记录的线路, 详见 Record.Line 接口。
- line_id: 解析记录的线路ID,详见 Record.Line 接口。
- type: 记录类型, 详见 Record.Type 接口。
- ttl: 记录的 TTL 值。
- value: 记录值。
- mx: 记录的 MX 记录值, 非 MX 记录类型,默认为 0。
- enabled: 记录状态:
- “0”: 禁用。
- “1”: 启用。
- status: 系统内部标识状态, 开发者可忽略。
- monitor_status: 该记录的D监控状态:
- “Ok”: 服务器正常。
- “Warn”: 该记录有报警, 服务器返回 4XX。
- “Down”: 服务器宕机。
- “”: 该记录未开启D监控。
- remark: 记录备注。
- updated_on: 记录最后更新时间。
- use_aqb: 是否开通网站安全中心:
- “yes”: 已经开启。
- “no”: 未开启。
备注:
- 通过 API 获取的解析记录列表,除了添加的解析记录,还会包含系统默认的 NS 记录。因此获取到的解析记录数量,会比控制台的记录数量更多,属于正常情况。
- 新添加的解析记录存在短暂的索引延迟,如果查询不到新增记录,请在 30秒后重试
最近更新于 2023-12-28 17:56
DNSPod 域名检测工具
查询域名信息,快速排查网站问题
网站自助排障
快速判断问题、提供合适的解决方案