基於HTTP的API服務介面說明書

2021-03-04 06:59:39 字數 3275 閱讀 8654

基於http的api服務介面說明書(v1.0.0.0)

目錄1. scadacloud app服務介紹 3

1.1 簡介 3

1.2 請求引數 3

1.3 舉例 4

2. 服務詳解 5

2.1 註冊 5

2.2 登陸 5

2.3 讀取資料點當前值 5

2.4 讀取資料點歷史資料 6

2.5 設定資料點 7

2.6 讀取未確認事件 7

2.7 確認指定的事件 8

2.8 確認所有的事件 8

2.9 取最大的告警級別 9

注意事項 10

附錄a: 11

scadacloud為終端提供基於http的介面:登陸,讀取資料點的實時資料,讀取資料點的歷史資料,設定資料點,讀取未確認事件,確認事件,確認所有未確認的事件,取當前最大告警級別。

scadacloud m2m與app通訊模型

參與scadacloud app服務的實體有兩個:scadacloud伺服器,它提供基於http的app服務,鏈結為終端裝置,如智慧型手機。

在本文件中,時間用距離2023年元月1日0時0分0秒的毫秒數來表示;二進位制值用」true」和」false」來表示;多狀態變數用由"0"~"9"組成的非負整數表示,如"0","21",分別表示狀態0和狀態21;數字量的值用由"-","0"~"9","."表示的浮點數,或科學計數法表示的浮點數。本文件對此約定不再另做說明。

api服務的返回值為utf-8編碼的字串。

使用get方式時,格式是 '

各引數的含義如下:

它表示使用者登陸。

鏈結格式:

引數說明:

username表示使用者名稱;

password表示密碼;

confirmpassword表示確認密碼

返回值格式:

如果註冊成功,返回字串「error=ok」,其他字串表示註冊錯誤。

鏈結格式:

引數說明:

username表示登陸使用者名稱;

password表示登陸密碼。

返回值格式:

如果登陸成功,返回字串「ok」,其他字串表示登陸錯誤。

引數格式:

& dpxid=dp_xid0&dpxid= dp_xid1……

引數說明:

dpxid表示資料點的xid值,多個dpxid表示一次取多個資料點的當前值,scadacloud對一次取多少個資料點的當前值沒有限制,由此帶來的頻寬問題由使用者自己考慮。

返回值格式:

一、 error=fault string,表示錯誤資訊。

二、count=count&dpxid=dp_xid0&timevalue=time0;value0…

count=count:count表示實際返回值多少個資料點的值。

dpxid=dp_xid0:表示資料點的xid為dp_xid0,隨後的timevalue=time0;value0資料點的時間和值。

比如,count=1&dpxid=dp_001210&timevalue=1396744235937;false,表示返回乙個資料點的值,該資料點的xid為dp_001210,值的時間為1396744235937,值為false。

假如沒有當前值返回,返回」count=0」。

引數格式:

& dpxid=dp_xid&starttime=time0&finaltime=time1

引數說明:

dpxid表示資料點的xid值, 一次只能取乙個資料點的歷史資料。

starttime表示開始時間,starttime=0表示從最早的開始時間。

finaltiem表示結束時間,finaltime=0表示結束時間為當前時間。

starttime=0&finaltime=0表示取全部的歷史資料。

一次最多能取1k個歷史資料。如果要取大於1k的歷史資料,可以多次取,即每次的starttime為上一次的最後的那個歷史資料的時間值加1.

一次只能取乙個資料點的歷史資料。

返回值格式:

一、 error=fault string,表示錯誤資訊。

二、dpxid=dp_xid&count=count&timevalue=time0;value0;time1;value1……

dpxid=dp_xid表示資料點的xid為dp_xid。

count=count表示包含多少個歷史資料。

timevalue為歷史資料的時間和值,時間和值總是成對出現,時間與值用分號隔開。

比如,dpxid=dp_001210&count=2&timevalue=1367243381729;true;1367243681729;false,表示返回資料點dp_001210的兩個歷史資料,時間和值分別為1367243381729;true和1367243681729;false。

假如沒有歷史資料返回,返回」 dpxid=dp_xid&count=0」。

引數格式:

引數說明:

dpxid表示資料點的xid,多個dpxid表示一次設定多個資料點的值。

value表示設定的值。

dpxid與value總是成對出現。

返回值格式:

一、 error=fault string,表示錯誤資訊。

二、count=count&dpxid=dp_xid……,count表示設定成功的資料點個數,dpxid表示設定成功的資料點。未在返回值列出的資料點表示沒有設定,比如,該資料點沒有啟用。

引數格式:

一次最多讀取100條未確認事件。

引數說明:

無引數返回值格式:

一、error=fault string,表示錯誤資訊。

二、count=count&event=event_id;alarm_level;active_time_stamp;content;return_to_normal_time_stamp;return_to_normal_message;is_silenced……。

count=count,表示返回至中有count條事件。

event= event_id;alarm_level;active_time_stamp;content;return_to_normal_time_stamp;return_to_normal_message;is_silenced,

表示事件的內容,事件的各自斷由分號隔開,依次分別為事件id,告警級別,生成時間,內容,返回正常狀態時間,返回正常狀態內容,是否是靜音。

引數格式:

引數說明:

eventide=eventid,表示需要確認的事件id。

基於ADV7125的嵌入式系統VGA介面設計

同步訊號同步訊號同步訊號控制端 消隱訊號控制端,以及省電模式控制端。它能夠與各種高解析度彩色圖形系統相容。adv7125功能框圖。adv7125有3個 資料暫存器data register和乙個 控制暫存器power down mode。資料暫存器的3個輸入端分別連線紅綠藍三色的數字 訊號,資料暫存...

基於創新服務模式的科技服務平台

摘要 科技服務業中,科技服務機構與企業無法對接以及科研成果難於轉化的現象普遍存在。通過借鑑電子商務的聚集理念和運營模式,在整合多方科技服務資源的基礎上,該文提出了建立乙個以科技服務機構和科技型中小企業為主體的服務對接平台的構想。在該平台,企業可 申請機構發布的服務產品,機構可 處理企業的申請並提交服...

基於XFire的Web服務實現

使用xfire編寫乙個簡單的web服務程式以及呼叫該web服務的程式。j a myeclipse 8.5 tomcat 6.0 使用xfire實現了計算矩形面積的程式,輸入長 寬兩個引數計算輸出矩形的面積,並編寫客戶端程式對此web服務進行呼叫。1.配置環境 安裝tomcat 6.0,將其加入到my...