這是本文檔舊的修訂版！
目錄
小辣椒（3322）動(dòng)態(tài)域名更新API
通過小辣椒API，您可以很容易開發(fā)出動(dòng)態(tài)域名客戶端，或者將動(dòng)態(tài)域名功能集成到自己的設(shè)備中。
任何小辣椒的賬戶，都可以使用動(dòng)態(tài)域名API，如果您還沒有注冊(cè)小辣椒，請(qǐng)點(diǎn)此注冊(cè)。
介紹
- Client的請(qǐng)求應(yīng)該使用HTTP/1.0以上協(xié)議，Server的響應(yīng)一定為HTTP/1.0
- Client 和 Server,通過 HTTP GET 或 HTTP POST 請(qǐng)求進(jìn)行交互。
- 需要事務(wù)處理，Client發(fā)送完整的請(qǐng)求，并且解析服務(wù)器端的相應(yīng)，保證域名更新的成功。
- 如果請(qǐng)求失敗，則需要延時(shí)一段時(shí)間（推薦1分鐘）進(jìn)行重試，直到域名更新成功。
- 更新請(qǐng)求的觸發(fā)，有兩種方式：
事件驅(qū)動(dòng)，客戶端偵聽系統(tǒng)的IP請(qǐng)求變化事件，一旦改變了IP，立即發(fā)起更新請(qǐng)求，推薦這種方式，更新沒有延時(shí)。
定時(shí)更新，每隔一定時(shí)間，發(fā)起更新請(qǐng)求，注意兩次間隔時(shí)間不能短于1分鐘（收費(fèi)用戶不能短于15秒），如果連續(xù)3次以上頻繁請(qǐng)求，該域名會(huì)被系統(tǒng)自動(dòng)封堵，返回 abuse 代碼。
- IP的變化檢測，可以采用 web 方式進(jìn)行檢測，客戶端可以訪問 http://ip.3322.net 獲取自己的IP，兩次請(qǐng)求返回的IP變化了，就發(fā)起更新請(qǐng)求。注意訪問 http://ip.3322.net 的兩次間隔時(shí)間不能短于1分鐘，如果連續(xù)3次以上頻繁請(qǐng)求，該IP會(huì)被系統(tǒng)自動(dòng)封堵
- 使用HTTP驗(yàn)證作為API的用戶身份驗(yàn)證方式。
- User-Agent, 代表客戶端名稱、版本，需要根據(jù)設(shè)備類型、名稱、特征進(jìn)行自定義，一般包括設(shè)備的廠家、型號(hào)、firmware版本號(hào)。請(qǐng)不要使用示范中的名稱，否則可能被封堵。
動(dòng)態(tài)域名更新接口
接口地址
API URL
http://members.3322.net/dyndns/update
HTTP請(qǐng)求
GET /dyndns/update?hostname=yourhost.ourdomain.ext&myip=ipaddress&wildcard=OFF&mx=mail.exchanger.ext&backmx=NO&offline=NO HTTP/1.1 Host: members.3322.net Authorization: Basic username:password User-Agent: myclient/1.0 me@null.net
參數(shù)說明
- username:password
該參數(shù)必選, 用戶名和密碼用來進(jìn)行身份認(rèn)證，必須使用 base64進(jìn)行編碼
- hostname=host.3322.org
該參數(shù)必選, 需要更新的域名
- myip=ipaddr
該參數(shù)可選, 域名對(duì)應(yīng)的IP。如果不指定，則服務(wù)器將選擇最佳的IP(一些Proxy會(huì)傳遞客戶端的IP, 這會(huì)被服務(wù)器檢測到)。如果傳遞的地址格式錯(cuò)誤，則忽略這個(gè)參數(shù)，而用服務(wù)器檢測 到的IP。
- wildcard=ON|OFF
該參數(shù)可選, 該參數(shù)可選，是否支持泛域名(通配符)，缺省為OFF。ON意為著 *.host.3322.org等同于host.3322.org
- mx=mailexchanger
該參數(shù)可選, 指明Mail eXchanger。必須能夠解析到一個(gè)IP，否則被忽略。如果不提供該參數(shù)或者 不能解析到一個(gè)IP，mx記錄會(huì)被刪除。
- backmx=YES|NO
該參數(shù)可選, 指明前面的mx參數(shù)會(huì)被設(shè)置成備份郵件服務(wù)器，即郵件會(huì)首先發(fā)送到你的機(jī)器上，如果 不成功，才會(huì)發(fā)送到備份郵件服務(wù)器上。
- offline=YES|NO Optional: Yes
該參數(shù)可選, 使域名暫時(shí)失效。
HTTP狀態(tài)返回碼
HTTP狀態(tài)返回碼為200或者500，其中200表示成功，500表示服務(wù)器內(nèi)部出錯(cuò)。但是動(dòng)態(tài)域名客戶端 請(qǐng)忽略HTTP返回碼，而是對(duì)下面的返回值進(jìn)行解析。比如返回值“interror”表示內(nèi)部出錯(cuò)，這時(shí)對(duì)應(yīng) 的HTTP狀態(tài)返回碼是500。
返回值
更新成功
- good
成功，IP地址已經(jīng)成功更新，good 后面會(huì)跟著所更新的IP地址
- nochg
成功，IP地址和上次請(qǐng)求沒有變化, nochg 后面會(huì)跟著所請(qǐng)求的IP地址
更新出錯(cuò)
- badauth
身份認(rèn)證出錯(cuò)，請(qǐng)檢查用戶名和密碼, 或者編碼方式出錯(cuò)。
- badsys
該域名不是動(dòng)態(tài)域名，可能是其他類型的域名（智能域名、靜態(tài)域名、域名轉(zhuǎn)向、子域名）。
- badagent
由于發(fā)送大量垃圾數(shù)據(jù)，客戶端名稱被系統(tǒng)封殺。
參數(shù)出錯(cuò)
- notfqdn
沒有提供域名參數(shù)，必須提供一個(gè)在小辣椒注冊(cè)的動(dòng)態(tài)域名域名。
- nohost
域名不存在，請(qǐng)檢查域名是否填寫正確。
- !donator
必須是收費(fèi)用戶，才能使用 offline 離線功能。
- !yours
該域名存在，但是不是該用戶所有。
- !active
該域名被系統(tǒng)關(guān)閉，請(qǐng)聯(lián)系小辣椒客服人員。
- abuse
該域名由于段時(shí)間大量發(fā)送更新請(qǐng)求，被系統(tǒng)禁止，請(qǐng)聯(lián)系小辣椒客服人員。
服務(wù)器出錯(cuò)
- dnserr
DNS 服務(wù)器更新失敗。
- interror
服務(wù)器內(nèi)部嚴(yán)重錯(cuò)誤，比如數(shù)據(jù)庫出錯(cuò)或者DNS服務(wù)器出錯(cuò)。
獲取IP接口
客戶端可以通過該接口獲取自己的IP，用于客戶端檢測IP的變化。
注意訪問 http://ip.3322.net 的兩次間隔時(shí)間不能短于1分鐘，如果連續(xù)3次以上頻繁請(qǐng)求，該IP會(huì)被系統(tǒng)自動(dòng)封堵
接口地址
API URL
http://ip.3322.net
參數(shù)說明
無
返回值
客戶端的IP地址
常見問題
- 沒有對(duì)請(qǐng)求做事務(wù)處理，沒有檢查服務(wù)器的返回值，沒有判斷域名更新是否成功
- 更新失敗以后，沒有記錄日志，沒有進(jìn)行延時(shí)、重試的過程
- 請(qǐng)求過于頻繁，導(dǎo)致域名被服務(wù)器封殺
- 客戶端使用實(shí)例的名字，沒有根據(jù)自己設(shè)備的類型、名稱、特征進(jìn)行自定義
設(shè)備認(rèn)證
小辣椒動(dòng)態(tài)域名更新API簡單易用，方便了開發(fā)者和集成商開發(fā)自己的客戶端，給設(shè)備增加動(dòng)態(tài)域名功能。
但是如果對(duì)客戶端的理解不深入，會(huì)產(chǎn)生一些錯(cuò)誤或者更新失敗，導(dǎo)致動(dòng)態(tài)域名更新失敗，用戶無法通過域名訪問設(shè)備。
小辣椒為了規(guī)范域名的更新流程，保障設(shè)備的正常工作，對(duì)市場上使用小辣椒動(dòng)態(tài)域名更新API的設(shè)備進(jìn)行認(rèn)證：
- 由小辣椒的工程師，對(duì)設(shè)備進(jìn)行認(rèn)真，全面的測試，保證設(shè)備能夠在各種網(wǎng)絡(luò)條件、各種異常條件下正常更新域名
- 提供認(rèn)證的設(shè)備清單，推薦小辣椒的廣大用戶選用
設(shè)備認(rèn)證的具體方法，請(qǐng)參見設(shè)備認(rèn)證
