基于HTTP的API服務(wù)接口說明書

1、http 協(xié)議與 scadacloud 通信說明書(v) scadacloud proxy 協(xié)議說明書(v)各專業(yè)全套優(yōu)秀畢業(yè)設(shè)計(jì)圖紙基于 http 的 api 服務(wù)接口說明書(v)minp technologyaddress:深圳市龍崗區(qū)吉祥路風(fēng)臨國際 a1404telaxttp 協(xié)議與 scadacloud 通信說明書(v)http 協(xié)議與 scadacloud 通信說明書 vpage 2 of 11 目目目 錄錄錄 1. scadacloud app 服務(wù)介紹

2、服務(wù)介紹.31.1 簡介.31.2 請求參數(shù).31.3 舉例.42. 服務(wù)詳解服務(wù)詳解.52.1 注冊.52.2 登陸.52.3 讀取數(shù)據(jù)點(diǎn)當(dāng)前值.52.4 讀取數(shù)據(jù)點(diǎn)歷史數(shù)據(jù).62.5 設(shè)置數(shù)據(jù)點(diǎn).72.6 讀取未確認(rèn)事件.72.7 確認(rèn)指定的事件.82.8 確認(rèn)所有的事件.82.9 取最大的告警級別.9注意事項(xiàng)注意事項(xiàng).10附錄附錄 a： .11http 協(xié)議與 scadacloud 通信說明書(v)http 協(xié)議與 scadacloud 通信說明書 vpage 3 of 111. scadacloud app 服務(wù)介紹服務(wù)介紹1.1 簡介簡介scadaclou

3、d 為終端提供基于 http 的接口：登陸，讀取數(shù)據(jù)點(diǎn)的實(shí)時數(shù)據(jù)，讀取數(shù)據(jù)點(diǎn)的歷史數(shù)據(jù)，設(shè)置數(shù)據(jù)點(diǎn),讀取未確認(rèn)事件，確認(rèn)事件，確認(rèn)所有未確認(rèn)的事件，取當(dāng)前最大告警級別。設(shè)備scadacloud服務(wù)器http終端設(shè)備scadacloud m2m 與 app 通信模型參與 scadacloud app 服務(wù)的實(shí)體有兩個：scadacloud 服務(wù)器,它提供基于 http 的 app服務(wù)，鏈接為 http:/ 1970 年元月 1 日 0 時 0 分 0 秒的毫秒數(shù)來表示；二進(jìn)制值用”true”和”false”來表示；多狀態(tài)變量用由09組成的非負(fù)整數(shù)表示，如0，21，分別表示狀態(tài) 0 和狀態(tài) 21；

4、數(shù)字量的值用由-，09，.表示的浮點(diǎn)數(shù)，或科學(xué)計(jì)數(shù)法表示的浮點(diǎn)數(shù)。本文檔對此約定不再另做說明。api 服務(wù)的返回值為 utf-8 編碼的字符串。1.2 請求參數(shù)請求參數(shù)使用 get 方式時,格式是 http:/ 各參數(shù)的含義如下：參數(shù)含義service服務(wù)名，當(dāng)前提供的服務(wù)有：login，登陸服務(wù)；dpvalue，取數(shù)據(jù)點(diǎn)當(dāng)前值；dphistory，取數(shù)據(jù)點(diǎn)的歷史數(shù)據(jù)；setdp，設(shè)置數(shù)據(jù)點(diǎn)；pendingevents，取未確認(rèn)事件；ackevents，確認(rèn)事件；ackpendingevents，確認(rèn)所有未確認(rèn)的事件；maxalarmlevel，取賬戶當(dāng)前最大的報警級別。param服務(wù)的參數(shù)；

5、不同的服務(wù)參數(shù)的個數(shù)和含義不一樣，詳見后續(xù)說明。1.3 舉例舉例http:/ 協(xié)議與 scadacloud 通信說明書(v)http 協(xié)議與 scadacloud 通信說明書 vpage 4 of 11它表示用戶 登陸。http 協(xié)議與 scadacloud 通信說明書(v)http 協(xié)議與 scadacloud 通信說明書 vpage 5 of 112. 服務(wù)詳解服務(wù)詳解2.1 注冊注冊鏈接格式：http:/ 表示用戶名；password 表示密碼；confirmpassword 表示確認(rèn)密碼返回值格式：如果注冊成功，返回字符串“err

6、or=ok” ，其他字符串表示注冊錯誤。2.2 登陸登陸鏈接格式：http:/ 表示登陸用戶名；password 表示登陸密碼。返回值格式：如果登陸成功，返回字符串“ok” ，其他字符串表示登陸錯誤。2.3 讀取數(shù)據(jù)點(diǎn)當(dāng)前值讀取數(shù)據(jù)點(diǎn)當(dāng)前值參數(shù)格式：http:/ & dpxid=dp_xid0&dpxid= dp_xid1參數(shù)說明：dpxid 表示數(shù)據(jù)點(diǎn)的 xid 值，多個 dpxid 表示一次取多個數(shù)據(jù)點(diǎn)的當(dāng)前值，scadacloud 對一次取多少個數(shù)據(jù)點(diǎn)的當(dāng)前值沒有限制，由此帶來的帶寬問題由用戶自己考慮。返回值格式：一、error=fault string，表示錯誤信息。h

7、ttp 協(xié)議與 scadacloud 通信說明書(v)http 協(xié)議與 scadacloud 通信說明書 vpage 6 of 11二、count=count&dpxid=dp_xid0&timevalue=time0;value0count=count：count 表示實(shí)際返回值多少個數(shù)據(jù)點(diǎn)的值。dpxid=dp_xid0：表示數(shù)據(jù)點(diǎn)的 xid 為 dp_xid0，隨后的 timevalue=time0;value0 數(shù)據(jù)點(diǎn)的時間和值。比如，count=1&dpxid=dp_001210&timevalue=139674423593

8、7;false,表示返回一個數(shù)據(jù)點(diǎn)的值，該數(shù)據(jù)點(diǎn)的 xid 為 dp_001210，值的時間為1396744235937，值為 false。假如沒有當(dāng)前值返回，返回”count=0”。2.4 讀取數(shù)據(jù)點(diǎn)歷史數(shù)據(jù)讀取數(shù)據(jù)點(diǎn)歷史數(shù)據(jù)參數(shù)格式：http:/ & dpxid=dp_xid&starttime=time0&finaltime=time1參數(shù)說明：dpxid 表示數(shù)據(jù)點(diǎn)的 xid 值， 一次只能取一個數(shù)據(jù)點(diǎn)的歷史數(shù)據(jù)。starttime 表示開始時間，starttime=0 表示從最早的開始時間。finaltiem 表示結(jié)束時間，finaltime=0 表示結(jié)束時間

9、為當(dāng)前時間。starttime=0&finaltime=0 表示取全部的歷史數(shù)據(jù)。一次最多能取 1k 個歷史數(shù)據(jù)。如果要取大于 1k 的歷史數(shù)據(jù)，可以多次取，即每次的starttime 為上一次的最后的那個歷史數(shù)據(jù)的時間值加 1.一次只能取一個數(shù)據(jù)點(diǎn)的歷史數(shù)據(jù)。返回值格式：一、error=fault string，表示錯誤信息。二、dpxid=dp_xid&count=count&timevalue=time0;value0;time1;value1dpxid=dp_xid 表示數(shù)據(jù)點(diǎn)的 xid 為 dp_xid。count=count 表示包含多少個歷史數(shù)據(jù)。time

10、value 為歷史數(shù)據(jù)的時間和值，時間和值總是成對出現(xiàn)，時間與值用分號隔開。比如，dpxid=dp_001210&count=2&timevalue=1367243381729;true;136724368http 協(xié)議與 scadacloud 通信說明書(v)http 協(xié)議與 scadacloud 通信說明書 vpage 7 of 111729;false，表示返回數(shù)據(jù)點(diǎn) dp_001210 的兩個歷史數(shù)據(jù)，時間和值分別為 1367243381729;true 和 1367243681729;false。假如沒有歷史數(shù)據(jù)返回，返回” dpxid=d

11、p_xid&count=0”。2.5 設(shè)置數(shù)據(jù)點(diǎn)設(shè)置數(shù)據(jù)點(diǎn)參數(shù)格式：http:/ 表示數(shù)據(jù)點(diǎn)的 xid，多個 dpxid 表示一次設(shè)置多個數(shù)據(jù)點(diǎn)的值。value 表示設(shè)置的值。dpxid 與 value 總是成對出現(xiàn)。返回值格式：一、error=fault string，表示錯誤信息。二、count=count&dpxid=dp_xid，count 表示設(shè)置成功的數(shù)據(jù)點(diǎn)個數(shù)，dpxid 表示設(shè)置成功的數(shù)據(jù)點(diǎn)。未在返回值列出的數(shù)據(jù)點(diǎn)表示沒有設(shè)置，比如，該數(shù)據(jù)點(diǎn)沒有激活。2.6 讀取未確認(rèn)事件讀取未確認(rèn)事件參數(shù)格式：http:/ 100 條未確認(rèn)事件。參數(shù)說明：無參數(shù)返回值格式：一

12、、error=fault string，表示錯誤信息。二、count=count&event=event_id;alarm_level;active_time_stamp;content;rethttp 協(xié)議與 scadacloud 通信說明書(v)http 協(xié)議與 scadacloud 通信說明書 vpage 8 of 11urn_to_normal_time_stamp;return_to_normal_message;is_silenced。count=count，表示返回至中有 count 條事件。event= event_id;alarm_leve

13、l;active_time_stamp;content;return_to_normal_time_stamp;return_to_normal_message;is_silenced，表示事件的內(nèi)容，事件的各自斷由分號隔開，依次分別為事件 id，告警級別，生成時間，內(nèi)容，返回正常狀態(tài)時間，返回正常狀態(tài)內(nèi)容，是否是靜音。2.7 確認(rèn)指定的事件確認(rèn)指定的事件參數(shù)格式：http:/ id。返回值格式：一、error=fault string，表示錯誤信息。二、count=count&eventid=eventid，count=count，表示確認(rèn)了多少條事件，eventide=eventid，表示被確認(rèn)的事件 id。2.8 確認(rèn)所有的事件確認(rèn)所有的事件參數(shù)格式：http:/ 100 條未確認(rèn)事件。參數(shù)說明：無返回值格式：一、error=fault string，表示錯誤信息。二、count=count，表示確認(rèn)了多少條事件。eventide=eventid，表示被確認(rèn)的事件 id。http 協(xié)議與 scadacloud 通信說明書(v)http 協(xié)議與 scadacloud 通信說明書 vpage 9 of 112.9 取最大的告警級別取最大的告警級別參數(shù)格式：http:/ string，表示錯誤信息。二、maxala