有关TSDB数据服务API V2.0


这是 API 的旧版本。最新版本,参见 V2.1


TSDB数据服务API是基于TSDB的资产数据服务。EnOS时序数据库(TSDB)为设备上传的实时数据和经流数据处理的数据、以及通过离线通道整合的时序数据提供高效和稳定的存储和管理。TSDB数据服务API为开发者提供存储于EnOS TSDB中的数据查询服务。目前EnOS的TSDB数据库支持存储资产的:

  • AI测点原始数据

  • AI测点分钟级归一化数据

  • 设备状态(DI)数据

  • 设备状态时长

  • 通用类型数据

  • 电量数据


有关TSDB存储的详细信息,参见 时序数据管理


针对以上数据类型,TSDB服务提供以下配套的接口供开发者调用获取数据并进行应用开发。

API列表

API名称

描述

适用于 EnOS Cloud

适用于 EnOS Edge

Filter Asset Latest Data

过滤查询多个设备单个测点的最新数据。支持查询的数据类型为Numeric和String

Get Asset AI Data with Aggregation Logic

获取指定设备的指定测点在某段时间内的AI原始数据

Get Asset AI Raw Data

获取指定设备的指定测点在某段时间内的AI原始数据

Get Asset Current Day Electric Power

获取指定设备从本地时间0点开始到当前时间已累计的电量数据

Get Asset DI Data

获取指定设备在某段时间内的状态(DI)数据

Get Asset DI Data Duration

获取指定设备在一段时间内不同状态(DI)的时长

Get Asset Electric Power Data

获取指定设备在某段时间内的电量数据

Get Asset Generic Data

获取指定设备的指定测点在某段时间内通用类型的数据

Get Asset Latest Data

获取指定设备所有测点的最新数据

Get Asset Raw Data By Time Range

获取指定设备的指定测点在某段时间内原始数据的值(包括AI、DI、和通用数据类型)

Get Asset Unified Raw Data

用于查询标准数据 + 非标准数据的统一接口

×

API 版本


下表列出 TSDB 数据服务企业版与轻量版包含的 API 服务。


操作名称

企业版

轻量版

Filter Asset Latest Data

Get Asset AI Data with Aggregation Logic

Get Asset AI Raw Data

Get Asset Current Day Electric Power

Get Asset DI Data

Get Asset DI Data Duration

Get Asset Electric Power Data

Get Asset Generic Data

Get Asset Latest Data

Get Asset Raw Data By Time Range

Get Asset Unified Raw Data

API请求方法

TSDB数据服务API V2.0 支持GET和POST两种请求方法:

  • GET方法:请求参数包含在请求URL中,适用于请求参数较少的情况

  • POST方法:请求参数以表单的形式包含在请求体中,适用于请求参数较长的情况

API参考文档包含了对两种请求方法的详细说明。SDK示例推荐Poseidon版本:

<dependency>
    <groupId>com.envisioniot</groupId>
    <artifactId>apim-poseidon</artifactId>
    <version>0.1.14</version>
</dependency>

通用错误码

代码

错误信息

描述

0

Success

成功。

400

Invalid param error

存在不合法的请求参数,具体信息请查看error message。

701

Data service ERROR

服务出错。

702

An error occurred when execute query in data service

查询数据服务异常。