AnyLink Cloud 云平台WebApi数据调用接口 标准版

接口说明

  • 适用范围:使用 AnyLink 系列产品的用户,可以调用本文档描述的 RESTful API,查询和控制设备数据。
  • 接口地址:https://s1.anylink.io:8443,本文档内简称为 <%=BaseUrl%>。
  • 编码方式:除非特殊说明,本文档中的接收和返回参数编码方式都为 UTF-8。
  • 兼容性:接口返回数据为 JSON 格式,在后续的升级中扩展字段,会兼容旧版本。
  • http接口地址:http://s1.anylink.io:8600。

接口鉴权

采用 token 鉴权:调用其他接口前,需要先用账号密码获取 token。

请求类型: POST
URI: /user/getToken 

参数:

返回:

  • 多租户登录的账号格式为 用户名@企业号,账号密码请咨询企业管理员。
  • token 有效期 600 分钟,超期需要重新获取。
  • 旧版登陆方式 /user/login 仍然有效,但建议尽快切换至新版多租户登陆。

名词解释

  • 网关(agent):即 AnyLink 系列硬件产品,DA、SE、IE 等。

  • 设备(device):即网关监控的设备,网关采集设备的数据,上传到云端。

  • 数据项(dataItem):某一个设备中配置的监控数据项,可写数据支持远程控制。

  • 告警(alarm):某一个设备中,针对数据项配置的告警规则,触发告警产生告警消 息,告警解除产生恢复通知。

设备查询接口

分页获取网关-设备列表

请求类型: GET
URI: /agentList/pagination

参数:

返回:

数据项查询接口

分页获取单个设备的实时数据

请求类型: GET
URI: /currentdata/pagination

参数:

返回:

分页获取单个数据项的历史数据

说明:历史数据查询时间跨天则触发聚合,小于7天按10分钟聚合,小于30天按1小时 聚合,单次查询时间跨度不要超过30天。
请求类型: GET
URI: /historydata/list

参数:

返回:

告警查询接口

分页获取设备的存活告警生命周期

请求类型: GET
URI: /alarm/alarmLifeCycle

参数:

返回:

分页获取设备的历史告警生命周期

请求类型: GET
URI: /hisalarm/alarmLifeCycle

参数:

返回:

远程控制接口

向设备数据项发送控制命令

请求类型: PUT
URI: /control/v2.1

参数:

返回:

获取设备数据项控制结果

说明: 获取控制结果(需循环访问,直到得到结果) 请求类型: GET
URI: /control/result

参数:

返回:

附录

datatype_id对应的数据类型

© 程晨旭博客


原创文章,转载须以链接形式保留下方原出处。


原文地址:https://www.chengchenxu.cn/anylink/356.html





发表评论

电子邮件地址不会被公开。 必填项已用*标注