API 文档
文档目录
    加载中
文档中心 API 文档 API 开发规范

API 开发规范

API说明

注意:本页面提供 API 文档为 DNSPod 传统 API ,仅支持 DNSPod Token。仅限主账号调用,子账号不可用。 若您非使用 D 监控功能,推荐使用 腾讯云 API 3.0 ,支持 CAM 权限管理,同时支持主账号、子账号调用。兼容腾讯云 API 密钥,提供 API Explorer、API 调用统计等工具,还可以与腾讯云其他产品更好协同使用。

DNSPod API 使用户能更方便、更灵活的管理自己的域名和记录。
不允许任何第三方使用本 API 获取、操作用户数据。如有类似需求,欢迎 联系合作

API开发规范

1. 关于滥用:
包括但不限于以下情形都被视为滥用:

  • 短时间内大量添加、删除、修改、刷新域名或者记录,或者设置记录状态。
  • 记录内容没有任何改变的刷新,比如动态 DNS 中 IP 没变也请求修改记录。
  • 程序逻辑不严谨、程序死循环等等,可能造成大量无效、重复的请求。
  • 其它没有提到的,但会给系统带来压力的请求行为。

说明:
为了保障您和广大开发者的利益,请您合理使用 API ,对于任何滥用 API 的行为,DNSPod 有权对此进行封禁,并保留最终解释权。

2. 禁止登录:
如果帐号尝试登录错误次数在 5 分钟内超过 30 次则会被禁止登录 1 个小时,写程序的时候特别是动态客户端的时候必须判断是否登录成功,如果不成功必须马上停止尝试。如果使用动态客户端,在网页上修改了密码后务必到客户端修改,否则将不可用。

3. 关于封禁:
由于滥用 API 将会导致帐号在 API 中封禁,但并不影响在官方网站上的使用。封禁一定的时间后会自动解除,一般需要 1 个小时后才会解封,所以请小心操作,请勿使用 API 进行大量测试。

4. 关于请求:

  • 请求的地址为 https://dnsapi.cn/ 开头的地址,基于 SSL 安全传输。为了安全必须用 https 开头的地址,否则将有可能被封禁。
  • 只支持 POST 方法请求数据,用其它方法会提示错误。
  • 请用 UTF-8 编码进行数据传输,返回的数据也是 UTF-8 编码的。

5. 关于UserAgent:
请求的时候必须设置 UserAgent ,如果不设置或者设置为不合法的(比如设置为浏览器的)也会导致帐号被封禁 API 。
UserAgent 的格式必须为:程序英文名称/版本(联系邮箱),比如:MJJ DDNS Client/1.0.0 (dnspod@dnspod.cn)

6.关于安全:
用户需要输入用户邮箱和密码才能进行下一步的操作,如果需要在客户端上或数据库中保存用户的信息,必须加密后保存,不得明文保存在文件中。

7. 技术支持:

最近更新于 2021-07-30 11:11

DNSPod 域名检测工具

查询域名信息,快速排查网站问题

网站自助排障

快速判断问题、提供合适的解决方案