# 云服务(公测版)

# 介绍

重要提醒

通知终端提供了云服务功能,目前处于 公测版 免费试用,后期会变为 订阅制

本功能用来解决下列场景无法通过IP直接推送问题

  • 公网云服务无法通过IP地址直接推送给报警灯的问题。
  • 告警发送者与设备网段不一致,IP不可达的情况
  • ……以及所有告警发送端 无法通过IP地址访问到终端的情况

# 已开放的功能

目前仅罗列上述功能,其他功能文档将逐步完善中。

# 接口说明

在PostMan中,将原本通过IP地址方式推送给设备的URL,替换为控制基地址+Path其他数据保持不变。 举例:

原来的推送地址为 http://<设备IP地址>/api/api/send_msg

新的推送地址为 <控制基地址>/api/send_msg

# 具体的案例(注意红色为变化部分)

原告警推送地址:

http://192.168.0.66/api/api/send_msg

云端推送地址:

https://api.eyegroup.cc/alerter/636fadf4-c9cc-7957-e0d8-73a99e8f128b/api/send_msg

发送即可得到返回结果。

# 配置方法 - V1.7.3 ≤ 设备版本

# 1、激活

点击更新控制基地址,获取最新的设备基地址。

# 2、启动服务

创建好控制基础地址后,打开云服务配置中的云服务开关,稍等片刻后状态会变为在线-已注册,同时界面会展示设备当前的控制基地址。

# 3、绑定组织(可选操作)

点击绑定组织按钮,输入组织OID,点击确定后,会提示已绑定到的组织。

# 配置方法 - V1.7.0 ≤ 设备版本 ≤ V1.7.2

# 1、绑定

使用微信,扫描云服务配置中的二维码,在手机界面中点击生成新地址,创建设备在云端的控制基地址。

# 2、启动服务

创建好控制基础地址后,打开云服务配置中的云服务开关,稍等片刻后状态会变为在线-已注册,同时界面会展示设备当前的控制基地址。

# 旧版告警推送(已废弃)(设备版本 <= V1.67)

重要提醒

该接口目前为测试云推送的效果使用,主要用来提供项目可行性验证,以便于规划本产品在您方案中的对接方式。 后续版本(V1.7后)将使用的新的URL地址取代当前地址。

该接口后续版本会暂时保留功能以便于兼容旧版本设备,新版本设备(>=V1.7)请勿使用该接口

之前的云推送接口中暂未加入签名校验,后续版本将引入签名校验以保证安全性。

即:云告警推送接口数据结构与常规Api接口完全一致。签名算法

# 使用前提

终端具备外网访问权限

设备版本:V1.5.0 <= 设备版本 <= V1.6.7

# 启用服务

首先配置好设备的网络,让其可以链接外网。 然后登录后台管理页面进入系统设置->云服务配置,使用手机微信扫描管理二维码,见下图。

使用手机微信扫描二维码之后,会进入到生成地址界面,点击生成新推送地址按钮,可以生成设备的新推送地址,见下图。

得到新的推送地址后,回到设备云服务配置界面,启用云服务开关,等待5秒后,当云服务状态显示为正常后,即启用配置完毕。

# 使用推送地址

推送地址的使用非常简单,只需要像常规Api那样推送告警信息即可。请参见常规Api使用

请求接口的Postman界面演示效果见下图

# 返回结果的说明

使用云服务推送接口返回值与使用常规Api推送给设备数据结构大体相同,但是有部分字段变化,以下为对字段变化的说明。

data/data:表示当前队列中待同步的告警数量。即有多少报警还未被设备拉取。如果该值过大,请检查设备是否离线、或告警发送速度过快导致告警积压。

注意

目前平台告警队列上限暂定为30,超出后无法继续推送新告警,直到告警信息被设备取走。

data/last_pull:新增字段,表示设备上次从平台同步数据的时间。如果时间与现在时间差距过大,请检查设备是否离线。

data/id:推送信息的id,暂时无用。

# 注意事项

目前云平台对告警信息保存时间限制为5天,期限内没有同步则会被清理!