璺ㄥ钩?板??舵?版???Rest API
0. 缁艰堪
Rest API?????ㄥ?????
- 瑕?浣挎?版????杩?Rest API瀵瑰??撮?诧?璇峰??璁剧疆瀵瑰???甯??版??」锛?IDE宸︿?瑙????版???????宸︿晶瀵艰??????瀵瑰???甯?锛???浠跺す锛???瀵瑰???甯??版??」??REST
- Rest API??瑕?寮???EST???★???缃??瑰?锛?宸︿?瑙????版???????宸︿晶瀵艰??????瀵瑰???甯?锛???浠跺す锛???REST???♀???鹃??????EST???★?榛?璁ょ??e??000锛?????缃??
- 纭??Http???″?ㄨ??鹃??锛????婚?€????宸︿晶瀵艰?????????扁?????ㄨ?缃???Http???″???搴?璇ュ凡缁????ㄨ??鹃??锛????ㄩ?ㄤ?瀛?骞惰?琛?
??浠??寤鸿??ㄥ?ㄥ?????????????″?ㄤ腑寮???est API锛?杩????芥???存?舵????缃?缁??诲?伙?寮???涓ラ??????????濡????ㄥ???浣跨???璇疯????寮???/span>瀹??ㄧ?????
濡????ㄥ????瀹??ㄧ???锛?????瑕?????杩?http璇锋?杩?琛??ㄦ?疯?璇?锛??峰??璇???韩浠界?ㄧ??token锛?骞跺?ㄤ?????璇锋?涓??哄甫杩?涓?oken锛??哄甫浣?缃??URL ?ヨ????帮????蜂??规??ㄤ??㈢??绀轰?涓???般??
娉ㄦ??锛?????API??杩????硷?response body锛?涓??戒??哄甫涓?涓?ode瀛?娈碉??ㄦ?ユ??璁拌?姹????︽????锛?code涓?琛ㄧず????锛?code涓哄?跺??艰〃绀哄け璐ユ??????璇???
1. ?ㄦ?风?诲???GET??
URL: /api/userlogin
??杩帮?寮?????ㄧ???????瑕????ㄥ凡娉ㄥ?????ㄦ?峰????瀵????诲?锛??峰??token锛?骞跺?ㄤ?????璇锋?涓??哄甫杩?涓?oken??
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
user | ??/span> | string ?ㄦ?峰?? |
pass | ??/span> | string 瀵??? |
绀轰?
璇锋?绀轰?
GET?规?锛?
杩???绀轰?
2. ?ㄦ?风?诲?恒??GET??
URL: /api/userlogout
??杩帮????ㄦ?API?哄甫token杩?琛??诲?猴??诲?哄??token澶辨????
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ??/span> | string ?诲??跺??扮??token |
绀轰?
璇锋?绀轰?
GET?规?锛?
杩???绀轰?
?诲?烘??????ode涓?锛?code涓?涓?浠h〃澶辫触
3. ?峰??瀹??舵?版????瑰??灞??у??绂伙???GET??
URL锛?/api/realdata
??杩帮?杩?绉??瑰??????峰??澶?涓??圭??澶?涓???у?兼?朵娇?ㄣ??
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
tags | ??/span> | string ?瑰??涓?甯﹀??э?澶?涓??奸???烽??寮?锛?濡?锛?A1,A2,A3 |
pars | ??/span> | string 灞??у??锛?澶?涓??奸???烽??寮?锛?濡?锛?PV,DESC,EU |
decimal | ??/span> | Integer 杩????板?煎??扮?瑰??浣??帮????艰????~9 |
绀轰?
璇锋?绀轰?
GET?规?锛?
杩???绀轰?
4. ?峰??瀹??舵?版????瑰??+灞??э???GET??
URL: /api/realdata
??杩帮?杩?绉??瑰?????浜??峰??姣?涓??圭????浜??瑰?灞??у?笺??
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
names | ??/span> | string ?瑰??甯﹀??э?澶?涓????烽??寮?锛?濡?锛?A1.PV, A2.PV, A3.DESC |
valueonly | ??/span> | Integer ???﹀??????硷????艰??????1锛??板?1浠h〃寮???quot;???????quot;妯″?锛?杩?绉?妯″?涓?锛???搴?浣?涓????版???????绮剧?锛??????峰?????版????寰?澶э?杩芥???蹇??????搴︾?????点??杩??????间互?扮?褰㈠?琛ㄧず锛?椤哄?涓?璇锋???ames???扮??椤哄??稿??锛?璇﹁?绀轰?2 |
decimal | ??/span> | Integer 杩????板?煎??扮?瑰??浣??帮????艰????~9 |
绀轰?1
璇锋?绀轰?1
GET?规?锛?
杩???绀轰?1
绀轰?2锛?valueonly锛?
璇锋?绀轰?2
GET?规?锛?
杩???绀轰?2
?扮????肩??椤哄?涓??ヨ?????ames??椤哄?涓??达???1.PV瀵瑰?100.00锛?A1.DESC瀵瑰?"绗??涓???quot;锛?A2.PV瀵瑰?50.00
杩?绉??瑰???杩????煎????ц?宸??浣?浣?绉??锛?浼?杈?????楂?锛?????瀵规?ц?芥????楂?瑕?姹????烘??/span>
搴?瀵规捣??瀹??舵?版???????API锛?璇﹁? ?峰????涓????逛???????瀹??舵?版??/span> ?? 娉ㄥ??椤硅?峰??瀹??舵?版??/span>
5. ?峰??瀵瑰???甯??版??」???圭???
URL: /api/realdir/{subnode1}/...
??杩帮?瑕?浠?Rest API涓??峰???版???璇ユ?版????瑰????灞??у?A1.PV锛?蹇?椤绘坊???般??瀵瑰???甯??版??」??涓?????甯告??浠????????涓????癸?灏?杩?涓????瑰??瀹???瀛????逛????????版???归??娣诲??杩???瀵瑰???甯??版??」???????惰蒋浠舵??渚??峰????涓????逛?????瀹??舵?版????API锛???浠ヤ?????杩?API?峰?????圭???????姹???
璺??????/span>
????/span> | 璇存?? |
---|
subnode1 | string ???瑰??锛?濡?锛?group1 |
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
绀轰?1
璇锋?绀轰?1
GET璇锋?锛?
杩???绀轰?1
杩??????剁???锛?姝や?涓????瑰??涓?oot锛??朵???涓や釜瀛?????roup1, group2锛?group1涓?杩???涓?涓??????evel2
绀轰?2
璇锋?绀轰?2
GET璇锋?锛?
杩???绀轰?2
6. ?峰????涓????逛???????瀹??舵?版????GET??
URL锛?/api/realdata/{nodeName1}/{nodeName2}/......
??杩帮???????oken澶????ヨ????帮????存?ユ?ヨ???涓????逛???瀹??舵?版??????搴?浣?????????瀵瑰???甯??版??」??????缃????????逛??????规?版????璇锋??瑰?绫讳技璁$??虹????浠剁?????
娉ㄦ??锛?瑕??ヨ????瑰?椤婚??缃??ㄥ?澶???甯??版??」涓?/span>
璺??????/span>
????/span> | 璇存?? |
---|
nodeName1 | string ???瑰??锛?濡?锛?group1 |
nodeName2 | string 瀛????瑰??锛?濡?锛?level2 |
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
recursion | ??/span> | Integer ???﹂??褰????硷?0??1锛?1浠h〃??褰?锛?姝ゆ?跺??????瑰???舵????瀛????逛??㈢???瑰?奸?戒?琚????锛?榛?璁や负0涓???褰?锛?璇﹁?绀轰?2 |
valueonly | ??/span> | Integer ???﹀??????硷????艰??????1锛??板?1浠h〃寮???quot;???????quot;妯″?锛?杩?绉?妯″?涓?锛???搴?浣?涓????版???????绮剧?锛??????峰?????版????寰?澶э?杩芥???蹇??????搴︾?????点??杩??????间互?扮?褰㈠?琛ㄧず锛?椤哄?涓????逛腑?圭??椤哄??稿??锛?璇﹁?绀轰?3 |
decimal | ??/span> | Integer 杩????板?煎??扮?瑰??浣??帮????艰????~9 |
绀轰?1
璇锋?绀轰?1
GET?规?锛?
杩???绀轰?1
??璁惧?澶???甯??版??」涓???缃????group1??锛???group2??涓や釜骞跺?????广??
group1???逛???涓?涓??瑰?笺??g1.PV????涓?涓?????广??level2??锛?level2涓???涓?涓??瑰?笺??g2.PV????
group2???逛???涓?涓??瑰?笺??g3.PV????
??杩???????搴?浣?缁???濡?涓?锛?
绀轰?2锛???褰?锛?
璇锋?绀轰?2
GET?规?锛?
杩???绀轰?2
??褰??讹?group1浠ュ??瀹???瀛?????level2)涓??㈢???????归?戒?琚????
绀轰?3锛?valueonly锛?
璇锋?绀轰?3
GET?规?锛?
杩???绀轰?3
瀵瑰???甯??版??」????group1?????逛???A1.PV,A2.PV涓や釜?版???A1.PV?间负60锛?A2.PV?间负30锛???杩???濡?涓?
7. 娉ㄥ???瑰??锛??ㄤ??归??蹇??????版?????GET??
URL: /api/realdata
??杩帮????舵??浠???瑕?棰?绻??峰??涓?浜??瑰??圭???版?????杩?浜??规?伴??杈?澶?涓???甯?浜?涓??????逛?涓???杩??舵??浠???互????杩?浜??瑰?ㄧ郴缁?涓?敞????涓?涓??瑰?????瀛?锛?涔???????杩?杩?涓???瀛?绠???蹇????拌?峰???版????
娉ㄦ??锛?娉ㄥ???瑰??蹇?椤绘?哄甫?ㄦ?风?诲??跺??扮??token??姣?涓??ㄦ?风??娉ㄥ??琛?涓烘????ㄧ???涓??镐???绂荤????娉ㄥ??瀹?????瀛?瀵逛??朵??ㄦ?锋????????????浠ュ?充娇涓や釜?ㄦ?锋?板阀浣跨?ㄥ??涓?涓???瀛?娉ㄥ??浜?涓?????涓ょ??逛?涓?浼??茬???
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ??/span> | string ?诲??跺??扮??token锛???璁烘???﹀?????ㄧ???锛?娉ㄥ???瑰????蹇?椤讳娇?ㄤ?涓??ㄦ?风?诲?骞惰?峰??token?? |
regname | ??/span> | string 娉ㄥ??????瀛?锛??稿?浜?缁?涓?缁??硅捣涓?涓??规?????瀛? |
names | ??/span> | string ?瑰????灞??э?澶?涓????烽??寮?锛?渚?濡?锛?A1.PV,A2.PV,A3.PV |
绀轰?
璇锋?绀轰?
GET?规?锛?
杩???绀轰?
8. 娉ㄥ??椤硅?峰??瀹??舵?版????GET??
URL: /api/realdata
??杩帮?灏?涓?浜??规敞????涓烘敞??椤瑰??锛????存?ョ?ㄦ敞??????瀛??峰??杩?浜??圭??瀹??舵?版?????峰????瀹??舵?版???椤哄?涓?娉ㄥ???剁??椤哄??稿????
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ??/span> | string ?诲??跺??扮??token锛???璁烘???﹀?????ㄧ???锛????兼?跺?椤绘?哄甫token浠ュ?哄???ㄦ?枫?? |
regname | ??/span> | string 娉ㄥ??椤圭????绉?/span> |
decimal | ??/span> | Integer 杩????板?煎??扮?瑰??浣??帮????艰????~9 |
绀轰?
璇锋?绀轰?
GET?规?锛?
杩???绀轰?
9. 璁剧疆瀹??舵?版????POST??
URL: /api/realdata
??杩帮??╃??OST?规?+璇锋?浣????瑰?璁剧疆瀹??舵?版????璇峰???瑕?璁剧疆???版??互JSON?煎????ㄨ?姹?浣?锛?request body锛?涓???
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
绀轰?
璇锋?绀轰?
POST?规?锛?
璇锋?浣?锛??朵腑?硅???瑰??涓?tems锛?name涓虹?瑰??甯﹀??э?val涓鸿?璁剧疆????/span>
杩???绀轰?
code涓?琛ㄧず璁剧疆????锛?姝ゆ??essage涓虹┖瀛?绗︿覆锛?code涓?涓?琛ㄧず澶辫触锛?姝ゆ??essage??绀洪??璇?俊??/span>
10. 璁剧疆瀹??舵?版????扮??瑰?锛???POST??
URL: /api/realdata
??杩帮??╃??OST?规?+璇锋?浣????瑰?璁剧疆瀹??舵?版????璇峰???瑕?璁剧疆???版??互JSON?煎????ㄨ?姹?浣?锛?request body锛?涓???涓?涓?涓?绉??规?涓???????/span>
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
绀轰?
璇锋?绀轰?
POST?规?锛?
璇锋?浣?锛??朵腑names涓虹?瑰??甯﹀??х???扮?锛?vals涓鸿?璁剧疆???肩???扮?锛?瑕?姹?浜???椤哄?涓???/span>
杩???绀轰?
11. ?峰??澶?涓??堕?寸?瑰???叉?版????GET??
URL: /api/hisdata
??杩帮??峰??澶?涓??堕?寸?瑰???叉?版??/span>
绀轰?
璇锋?绀轰?
GET?规?锛?
杩???绀轰?
12. ?峰??涓?娈垫?堕?村?????叉?版????GET??
URL: /api/hisdata
??杩帮??峰??澶?涓??逛?娈垫?堕?村?????叉?版???娉ㄦ??锛??ゅ?濮??堕?村??缁????堕?村?锛?杩???瑕?璁剧疆?堕?撮?撮????
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
startTime | ??/span> | string ?煎?锛?yyyy-MM-ddThh:mm:ss.zzz(?ユ??涓??堕?寸????寮?锛?zzz姣?????甯? 濡?锛?2022-01-03T14:25:56.333 |
endTime | ??/span> | string ?煎?锛?yyyy-MM-ddThh:mm:ss.zzz(?ユ??涓??堕?寸????寮?锛?zzz姣?????甯? 濡?锛?2022-01-03T14:25:58.333 |
interval | ??/span> | integer ?撮???堕?存?绉??硷?2500浠h〃2.5绉? |
names | ??/span> | ?瑰??甯﹀??э?澶?涓??奸???烽??寮?锛?濡?锛?A1.PV,A2.DESC |
valueonly | ??/span> | Integer ???﹀??????硷????艰??????1锛??板?1浠h〃寮???quot;???????quot;妯″?锛?杩?绉?妯″?涓?锛???搴?浣?涓????版???????绮剧?锛??????峰?????版????寰?澶э?杩芥???蹇??????搴︾?????点??杩??????间互?扮?褰㈠?琛ㄧず锛????堕?村??????搴?锛?璇﹁?绀轰?2 |
decimal | ??/span> | Integer 杩????板?煎??扮?瑰??浣??帮????艰????~9 |
绀轰?1
璇锋?绀轰?1
GET?规?锛?
杩???绀轰?1
杩?绉??瑰??ㄦ?堕?寸?瑰?澶??讹?浼?杩???澶ч?????堕?村?绗︿覆锛?瀵艰?村??搴?浣?浣?绉??澶э???搴??堕?村???€??褰??堕?寸?瑰?澶?锛?涓????ц?借?姹??讹?搴????ㄧず渚?2???瑰?璇锋?
绀轰?2锛?valueonly锛?
璇锋?绀轰?2
GET?规?锛?
杩???绀轰?2
?扮????肩??椤哄?涓??堕?撮『搴?涓??达???1.PV????/span>50
瀵瑰??堕??/span>2022-02-22T15:22:34
?变?寮?濮?/缁????堕?村???堕?撮?撮??宸茬?纭??锛??扮????煎?搴????堕?村???绠?寰???/span>
杩?绉??瑰???杩????间?绉??锛?浼?杈?????楂?锛?????瀵规?ц?芥????楂?瑕?姹????烘??/span>
13. 璁剧疆???叉?版????POST??
URL: /api/hisdata
??杩帮??╃??OST?规?+璇锋?浣????瑰?璁剧疆???叉?版????璇峰???瑕?璁剧疆???版??互JSON?煎????ㄨ?姹?浣?锛?request body锛?涓???
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
绀轰?
璇锋?绀轰?
POST?规?锛?
璇锋?浣?锛?
杩???绀轰?
code涓?琛ㄧず璁剧疆????锛?姝ゆ??essage涓虹┖锛?code涓?涓?琛ㄧず澶辫触锛?姝ゆ??essage??绀洪??璇?俊??/span>
14. SQL?ヨ???POST??
URL: /api/SQL
??杩帮??╃??OST?规?+璇锋?浣????瑰?浼??ヤ?涓?甫??SQL璇??ョ??JSON锛?骞跺??扮被浼艰〃缁?????杩????笺??
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
绀轰?
璇锋?绀轰?
POST?规?锛?
璇锋?浣?锛?
杩???绀轰?
姣?涓????圭?稿?浜?琛ㄤ腑涓???锛????瑰???稿?浜???????
15. ?峰???ヨ???GET??
URL: /api/alarmdata
??杩帮?甯︽??startTime??endTime涓や釜?ヨ????版?朵负?峰?????叉?ヨ?锛??﹀??涓鸿?峰??瀹??舵?ヨ?锛?杩???互?规???瑰??锛?tags锛?锛??ヨ?浼???绾э?level锛?绛?澶?涓????拌?琛?绛?????
?ヨ?????/span>
????/span> | 蹇?椤?/span> | 璇存?? |
---|
token | ?︼?寮?????ㄧ?????蹇?瑕?锛? | string ?诲??跺??扮??token |
realalmcount | ??/span> | Integer ??澶???寰????℃??/span> |
org | ??/span> | string ??瀹?瑕??ヨ????规???ㄧ??? |
unit | ??/span> | Integer ??瀹?瑕??ヨ????规???ㄥ???? |
level | ??/span> | Integer ?ヨ?浼???绾э??峰??涓?灏?浜?璇ョ骇?????ヨ? |
tags | ??/span> | string ?瑰????琛??澶?涓??归???烽??寮?锛?濡?A1,A2,A3 |
groupbytag | ??/span> | Integer ???︽???瑰????缁?锛?涓??跺??缁?锛?涓??朵???缁? |
startTime | ?︼??哄甫??琛ㄧず?????叉?ヨ?锛? | string ?煎?锛?yyyy-MM-ddThh:mm:ss.zzz(?ユ??涓??堕?寸????寮?锛?zzz姣?????甯? 濡?锛?2022-01-03T14:25:56.333 |
endTime | ?︼??哄甫??琛ㄧず?????叉?ヨ?锛? | string ?煎?锛?yyyy-MM-ddThh:mm:ss.zzz(?ユ??涓??堕?寸????寮?锛?zzz姣?????甯? 濡?锛?2022-01-03T14:25:56.333 |
绀轰?
璇锋?绀轰?
GET?规?锛?
杩???绀轰?
??瀛?娈佃????ㄨ????肩ず渚?涓???/span>
ack 纭???舵????涓惧?硷?0??‘璁わ?1纭??锛?2?㈠?锛?3绂?姝??绂?姝㈣???璇ョ?圭???ヨ?琚??姝㈡??浜?锛?浣?浼?淇?瀛?涓??¤?褰?锛?
cat 绫诲???瀵瑰??ヨ???缃?腑??ID锛?妯℃???归?璁ゆ???典?锛?36浣?浣??ワ?37浣??ワ?38楂??ワ?39楂?楂??ワ?澶??版???典?浣跨?ㄩ?璁ら??缃??冲??/span>
desc 璇存??
eu ??浣?
group 灞?绾э????涓???2??roupB???逛?锛???浠ュ?娈靛?间负"root.groupB"
level ?ヨ?绾у????涓惧?硷?0浣?绾э?1楂?绾э?2绱ф?ワ??ㄧ?圭???ヨ????㈤??缃???
limit ???硷???涓轰?浣???锛?涓???锛?涓???锛?楂?楂???锛??ㄧ?圭???ヨ????㈤??缃??????涓?????负10锛?20锛?80锛?90
name ?瑰??锛?濡?A1锛?A2锛?B2
oper 纭????
parno 绫诲??ID锛?妯℃???归?璁ゆ???典?姝ゅ?娈典?cat瀛?娈电?稿??
prio 浼???绾э?瀵逛?妯℃???瑰???板??癸?姝ゅ?娈电???浜?level
time ?ヨ??堕??/span>
unit ?规???ㄧ??????锛?榛?璁や负0锛????ㄧ?硅?缃?腑??缃?/span>
val ?瑰??/span>