用户工具

站点工具


帮助:api

差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

Both sides previous revision 前一修订版
后一修订版
前一修订版
上一修订版 Both sides next revision
帮助:api [2011/10/23 13:42]
756489530 [介绍]
帮助:api [2013/03/04 13:21]
refactor [返回值]
行 1: 行 1:
-大家好是传奇小子 +====== 公云(3322)动态域名更新API ======
-认为俄警方三大困境的快乐感豆腐干地方大风过后岛谷科技豆腐干空间的风华高科都是符合公司的拉法基恶魔看了他的发挥viodfmtgiogb看vbg才vbgcbh烦得很让他富豪彼此vhbfthg斯蒂芬韩国法规汇编 +
-===== åŠ¨æ€åŸŸåæ›´æ–°æŽ¥å£ ​=====+
  
-==== æŽ¥å£åœ°å€ ​====+通过公云API,您可以很容易开发出动态域名客户端,或者将动态域名功能集成到自己的设备中。 
 + 
 +任何公云的账户,都可以使用动态域名API,如果您还没有注册公云,请[[http://​www.3322.net/​accounts/​signup/​|点此]]注册。 
 + 
 +===== 介绍 ===== 
 + 
 +  * Client的请求应该使用HTTP/​1.0以上协议,Server的响应一定为HTTP/​1.0 
 + 
 +  * Client 和 Server,​通过 HTTP GET 或 HTTP POST 请求进行交互。 
 + 
 +  * 需要事务处理,Client发送完整的请求,并且解析服务器端的相应,保证域名更新的成功。 
 + 
 +  * 如果请求失败,则需要延时一段时间(推荐1分钟)进行重试,直到域名更新成功。 
 + 
 +  * 更新请求的触发,有两种方式: 
 + 
 +事件驱动,客户端侦听系统的IP请求变化事件,一旦改变了IP,立即发起更新请求,推荐这种方式,更新没有延时。 
 + 
 +定时更新,每隔一定时间,发起更新请求,注意两次间隔时间不能短于1分钟(收费用户不能短于15秒),如果连续3次以上频繁请求,该域名会被系统自动封堵,返回 abuse 代码。 
 + 
 +  * IP的变化检测,可以采用 web 方式进行检测,客户端可以访问 http://​ip.3322.net 获取自己的IP,两次请求返回的IP变化了,就发起更新请求。注意访问 http://​ip.3322.net 的两次间隔时间不能短于1分钟,如果连续3次以上频繁请求,该IP会被系统自动封堵 
 + 
 +  * 使用[[http://​www.ietf.org/​rfc/​rfc2617.txt|HTTP]]验证作为API的用户身份验证方式。 
 + 
 +  * User-Agent, 代表客户端名称、版本,需要根据设备类型、名称、特征进行自定义,一般包括设备的厂家、型号、firmware版本号。请不要使用示范中的名称,否则可能被封堵。 
 + 
 + 
 +===== 动态域名更新接口 ===== 
 + 
 +==== 接口地址 ​====
  
 **API URL** **API URL**
行 11: 行 38:
 </​code>​ </​code>​
  
-**HTTP请求**+**HTTP请求**
  
 <​code>​ <​code>​
行 20: 行 47:
 </​code>​ </​code>​
  
-==== å‚数说明 ​====+==== 参数说明 ​====
  
   * username:​password   * username:​password
-该参数必选用户名和密码用来进行身份认证,必须使用 base64进行编码+该参数必选用户名和密码用来进行身份认证,必须使用 base64进行编码
  
   * hostname=host.3322.org   * hostname=host.3322.org
-该参数必选需要更新的域名+该参数必选需要更新的域名
  
   * myip=ipaddr   * myip=ipaddr
-该参数可选域名对应的IP。如果不指定,则服务器将选择最佳的IP(一些Proxy会传递客户端的IP+该参数可选域名对应的IP。如果不指定,则服务器将选择最佳的IP(一些Proxy会传递客户端的IP
-这会被服务器检测到)。如果传递的地址格式错误,则忽略这个参数,而用服务器检测 +这会被服务器检测到)。如果传递的地址格式错误,则忽略这个参数,而用服务器检测 
-到的IP。+到的IP。
  
   * wildcard=ON|OFF   * wildcard=ON|OFF
-该参数可选该参数可选,是否支持泛域名(通配符),缺省为OFF。ON意为着 ​*.host.3322.org等同于host.3322.org+该参数可选该参数可选,是否支持泛域名(通配符),缺省为OFF。ON意为着 ​*.host.3322.org等同于host.3322.org
  
   * mx=mailexchanger   * mx=mailexchanger
-该参数可选指明Mail eXchanger。必须能够解析到一个IP,否则被忽略。如果不提供该参数或者 +该参数可选指明Mail eXchanger。必须能够解析到一个IP,否则被忽略。如果不提供该参数或者 
-不能解析到一个IP,mx记录会被删除。+不能解析到一个IP,mx记录会被删除。
  
   * backmx=YES|NO   * backmx=YES|NO
-该参数可选指明前面的mx参数会被设置成备份邮件服务器,即邮件会首先发送到你的机器上,如果 +该参数可选指明前面的mx参数会被设置成备份邮件服务器,即邮件会首先发送到你的机器上,如果 
-不成功,才会发送到备份邮件服务器上。+不成功,才会发送到备份邮件服务器上。
  
   * offline=YES|NO Optional: Yes   * offline=YES|NO Optional: Yes
-该参数可选使域名暂时失效。+该参数可选使域名暂时失效。
  
 +==== HTTP状态返回码 ====
 +HTTP状态返回码为200、4XX、5XX,其中4XX表示认证错误,500表示服务器内部出错,200表示正常请求。但是动态域名客户端
 +请忽略HTTP返回码,而是对下面的返回值进行解析。比如返回值"​interror"​表示内部出错,这时对应的HTTP状态返回码是500。
  
-==== è¿”回值 ​====+==== 返回值 ​====
  
-=== æ›´æ–°æˆåŠŸ ​===+=== 更新成功 ​===
    
   * good   * good
-成功,IP地址已经成功更新,good 后面会跟着所更新的IP地址+成功,IP地址已经成功更新,good 后面会跟着所更新的IP地址
  
   * nochg   * nochg
-成功,IP地址和上次请求没有变化, nochg åŽé¢ä¼šè·Ÿç€æ‰€è¯·æ±‚çš„IP地址+成功,IP地址和上次请求没有变化, nochg 后面会跟着所请求的IP地址
  
  
-=== æ›´æ–°å‡ºé”™ ​===+=== 更新出错 ​===
  
   * badauth   * badauth
-身份认证出错,请检查用户名和密码或者编码方式出错。+身份认证出错,请检查用户名和密码或者编码方式出错。
  
   * badsys   * badsys
-该域名不是动态域名,可能是其他类型的域名(智能域名、静态域名、域名转向、子域名)。+该域名不是动态域名,可能是其他类型的域名(智能域名、静态域名、域名转向、子域名)。
  
   * badagent   * badagent
-由于发送大量垃圾数据,客户端名称被系统封杀。+由于发送大量垃圾数据,客户端名称被系统封杀。
  
-=== å‚数出错 ​===+=== 参数出错 ​===
  
   * notfqdn   * notfqdn
-没有提供域名参数,必须提供一个在小辣椒注册的动态域名域名。+没有提供域名参数,必须提供一个在公云注册的动态域名域名。
  
   * nohost   * nohost
-域名不存在,请检查域名是否填写正确。+域名不存在,请检查域名是否填写正确。
  
   * !donator   * !donator
-必须是收费用户,才能使用 ​offline ​离线功能。+必须是收费用户,才能使用 ​offline ​离线功能。
  
   * !yours   * !yours
-该域名存在,但是不是该用户所有。+该域名存在,但是不是该用户所有。
  
   * !active   * !active
-该域名被系统关闭,请联系小辣椒客服人员。+该域名被系统关闭,请联系公云客服人员。
  
   * abuse   * abuse
-该域名由于段时间大量发送更新请求,被系统禁止,请联系小辣椒客服人员。+该域名由于段时间大量发送更新请求,被系统禁止,请联系公云客服人员。 
 + 
 +=== 服务器出错 ===
  
   * dnserr   * dnserr
-DNS æœåŠ¡å™¨æ›´æ–°å¤±è´¥+DNS 服务器更新失败。
  
 +  * interror
 +服务器内部严重错误,比如数据库出错或者DNS服务器出错。
  
-===== èŽ·å–IP接口 ​=====+===== 获取IP接口 ​=====
  
  
-客户端可以通过该接口获取自己的IP,用于客户端检测IP的变化。+客户端可以通过该接口获取自己的IP,用于客户端检测IP的变化。
  
-注意访问 ​http://​ip.3322.net ​的两次间隔时间不能短于1分钟,如果连续3次以上频繁请求,该IP会被系统自动封堵+注意访问 ​http://​ip.3322.net ​的两次间隔时间不能短于1分钟,如果连续3次以上频繁请求,该IP会被系统自动封堵
  
  
-==== æŽ¥å£åœ°å€ ​====+==== 接口地址 ​====
  
 **API URL** **API URL**
行 110: 行 144:
 </​code>​ </​code>​
  
-==== å‚数说明 ​==== +==== 参数说明 ​==== 
-无+
  
-==== è¿”回值 ​====+==== 返回值 ​====
  
-客户端的IP地址+客户端的IP地址
  
  
-===== å¸¸è§é—®é¢˜ ​=====+===== 常见问题 ​=====
  
-  * æ²¡æœ‰å¯¹è¯·æ±‚做事务处理,没有检查服务器的返回值,没有判断域名更新是否成功 +  * 没有对请求做事务处理,没有检查服务器的返回值,没有判断域名更新是否成功 
-  * æ›´æ–°å¤±è´¥ä»¥åŽï¼Œæ²¡æœ‰è®°å½•æ—¥å¿—,没有进行延时、重试的过程 +  * 更新失败以后,没有记录日志,没有进行延时、重试的过程 
-  * è¯·æ±‚过于频繁,导致域名被服务器封杀 +  * 请求过于频繁,导致域名被服务器封杀 
-  * å®¢æˆ·ç«¯ä½¿ç”¨å®žä¾‹çš„名字,没有根据自己设备的类型、名称、特征进行自定义+  * 客户端使用实例的名字,没有根据自己设备的类型、名称、特征进行自定义
  
  
-===== è®¾å¤‡è®¤è¯ ​=====+===== 设备认证 ​=====
  
  
-小辣椒动态域名更新API简单易用,方便了开发者和集成商开发自己的客户端,给设备增加动态域名功能。+小辣椒动态域名更新API简单易用,方便了开发者和集成商开发自己的客户端,给设备增加动态域名功能。
  
-但是如果对客户端的理解不深入,会产生一些错误或者更新失败,导致动态域名更新失败,用户无法通过域名访问设备。+但是如果对客户端的理解不深入,会产生一些错误或者更新失败,导致动态域名更新失败,用户无法通过域名访问设备。
  
-小辣椒为了规范域名的更新流程,保障设备的正常工作,对市场上使用小辣椒动态域名更新API的设备进行认证:+小辣椒为了规范域名的更新流程,保障设备的正常工作,对市场上使用小辣椒动态域名更新API的设备进行认证:
  
-  * ç”±å°è¾£æ¤’的工程师,对设备进行认真,全面的测试,保证设备能够在各种网络条件、各种异常条件下正常更新域名 +  * 由小辣椒的工程师,对设备进行认真,全面的测试,保证设备能够在各种网络条件、各种异常条件下正常更新域名 
-  * æä¾›è®¤è¯çš„设备清单,推荐小辣椒的广大用户选用+  * 提供认证的设备清单,推荐小辣椒的广大用户选用
  
-设备认证的具体方法,请参见[[帮助:设备认证|设备认证]]+设备认证的具体方法,请参见[[帮助:设备认证|设备认证]]
帮助/api.txt · 最后更改: 2013/03/04 13:22 由 refactor