基于HTTP的API服务接口说明书.doc

http 协议与 scadacloud 通信说明书(v) scadacloud proxy 协议说明书(v) 各专业全套优秀毕业设计图纸 基于 http 的 api 服务接口说明书(v) minp technology address:深圳市龙岗区吉祥路风临国际 a1404 telfaxhttp 协议与 scadacloud 通信说明书(v) http 协议与 scadacloud 通信说明书 vpage 2 of 11 目目目 录录录 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 http 协议与 scadacloud 通信说明书(v) http 协议与 scadacloud 通信说明书 vpage 3 of 11 1. scadacloud app 服务介绍服务介绍 1.1 简介简介 scadacloud 为终端提供基于 http 的接口：登陆，读取数据点的实时数据，读取数据点 的历史数据，设置数据点,读取未确认事件，确认事件，确认所有未确认的事件，取当前 最大告警级别。 设备 scadacloud 服务器 http终端设备 scadacloud m2m 与 app 通信模型 参与 scadacloud app 服务的实体有两个：scadacloud 服务器,它提供基于 http 的 app 服务，链接为 /scadacloud/api/ext.jsp；终端设备，如智能手机。 在本文档中，时间用距离 1970 年元月 1 日 0 时 0 分 0 秒的毫秒数来表示；二进制值用” true”和”false”来表示；多状态变量用由“0“9“组成的非负整数表示，如“0“，“21“，分别 表示状态 0 和状态 21；数字量的值用由“-“，“0“9“，“.“表示的浮点数，或科学计数法 表示的浮点数。本文档对此约定不再另做说明。 api 服务的返回值为 utf-8 编码的字符串。 1.2 请求参数请求参数 使用 get 方式时,格式是 /scadacloud/api/ext.jsp?service=servicevalue0 count=count：count 表示实际返回值多少个数据点的值。 dpxid=dp_xid0：表示数据点的 xid 为 dp_xid0，随后的 timevalue=time0;value0 数据 点的时间和值。 比如，count=1false,表示 返回一个数据点的值，该数据点的 xid 为 dp_001210，值的时间为 1396744235937，值为 false。 假如没有当前值返回，返回”count=0”。 2.4 读取数据点历史数据读取数据点历史数据 参数格式： /scadacloud/api/ext.jsp?service=dphistoryvalue0;time1;value1 dpxid=dp_xid 表示数据点的 xid 为 dp_xid。 count=count 表示包含多少个历史数据。 timevalue 为历史数据的时间和值，时间和值总是成对出现，时间与值用分号隔开。 比如， dpxid=dp_001210true;136724368 http 协议与 scadacloud 通信说明书(v) http 协议与 scadacloud 通信说明书 vpage 7 of 11 1729;false，表示返回数据点 dp_001210 的两个历史数据，时间和值分 别为 1367243381729;true 和 1367243681729;false。 假如没有历史数据返回，返回” dpxid=dp_xidalarm_level;active_time_stamp;content;ret http 协议与 scadacloud 通信说明书(v) http 协议与 scadacloud 通信说明书 vpage 8 of 11 urn_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_ti me_stamp;return_to_normal_message;is_silenced， 表示事件的内容，事件的各自断由分号隔开，依次分别为事件 id，告警级别，生成时间，内 容，返回正常状态时间，返回正常状态内容，是否是静音。 2.7 确认指定的事件确认指定的事件 参数格式： /scadacloud/api/ext.jsp?service=ackevents&eventid=eventid 参数说明： eventide=eventid，表示需要确认的事件 id。 返回值格式： 一、error=fault string，表示错误信息。 二、count=count&eventid=eventid， count=count，表示确认了多少条事件， eventide=eventid，表示被确认的事件 id。 2.8 确认所有的事件确认所有的事件 参数格式： /scadacloud/api/ext.jsp?service=ackpendingevent 一次最多确认 100 条未确认事件。 参数说明： 无 返回值格式： 一、error=fault string，表示错误信息。 二、count=count，表示确认了多少条事件。 eventide=eventid，表示被确认的事件 id。 http 协议与 scadacloud 通信说明书(v) http 协议与 scadacloud 通信说明书 vpage 9 of 11 2.9 取最大的告警级别取最大的告警级别 参数格式： /scadacloud/api/ext.jsp?service=maxalarmlevel 参数说明： 无 返回值格式： 一、error=fault string，表示错误信息。 二、maxalarmlevel=max_alarm_level，表示账户的当前的最大告警级别。 http 协议与 scadacloud 通信说明书(v1.