有关TSDB数据服务API V2.1¶
该版本适用于 EnOS 2.1.3 或更新版本。旧版本，参见 V2.0。
TSDB数据服务API是基于TSDB的资产数据服务。EnOS 时序数据库（TSDB）为设备上传的实时数据和经流数据处理的数据、以及通过离线通道整合的时序数据提供高效和稳定的存储和管理。TSDB数据服务API为开发者提供存储于 EnOS TSDB 中的数据查询服务。目前 EnOS TSDB 数据库支持存储资产的：
AI测点原始数据
AI测点分钟级归一化数据
设备状态（DI）数据
设备状态时长
通用类型数据
电量数据
有关TSDB存储的详细信息，参见 时序数据管理。
针对以上数据类型，TSDB 数据服务提供以下配套的接口供开发者调用获取数据并进行应用开发。
API列表¶
API名称 |
描述 |
适用于 EnOS Cloud |
适用于 EnOS Edge |
|---|---|---|---|
过滤查询多个设备单个测点的最新数据。支持查询的数据类型为Numeric和String |
√ |
√ |
|
获取指定设备的指定测点在某段时间内的AI原始数据 |
√ |
√ |
|
获取指定设备的指定测点在某段时间内的AI原始数据 |
√ |
√ |
|
获取指定设备从本地时间0点开始到当前时间已累计的电量数据 |
√ |
√ |
|
获取指定设备在某段时间内的状态（DI）数据 |
√ |
√ |
|
获取指定设备在一段时间内不同状态（DI）的时长 |
√ |
√ |
|
获取指定设备在某段时间内的电量数据 |
√ |
√ |
|
获取指定设备的指定测点在某段时间内通用类型的数据 |
√ |
√ |
|
获取指定设备、测点的最新数据 |
√ |
√ |
|
获取指定设备的指定测点在某段时间内原始数据的值（包括AI、DI、和通用数据类型） |
√ |
√ |
|
获取指定设备的指定测点（支持多设备单侧点）在某段时间内的非标准原始数据 |
√ |
× |
|
删除指定设备、测点的最新数据 |
√ |
× |
|
获取指定设备、测点的最后变更数据。 |
√ |
× |
|
检测指定设备的测点数据是否为死数，同时返回测点的最后变更数据。 |
√ |
× |
|
提交数据清理任务，删除存储在 TSDB 中的资产历史数据。 |
√ |
× |
|
通过指定数据清理任务ID，获取数据清理任务运行结果。 |
√ |
× |
|
当数据清理任务运行失败时，通过指定数据清理任务ID，重新提交数据清理任务。 |
√ |
× |
|
删除 TSDB Schema 中不需要的 Measurement。 |
√ |
× |
|
用于查询标准数据 + 非标准数据的统一接口。。 |
√ |
× |
API 版本¶
下表列出 TSDB 数据服务标企业版与轻量版包含的 API 服务。
操作名称 |
企业版 |
轻量版 |
|---|---|---|
√ |
√ |
|
√ |
√ |
|
√ |
√ |
|
√ |
√ |
|
√ |
√ |
|
√ |
√ |
|
√ |
√ |
|
√ |
√ |
|
√ |
√ |
|
√ |
√ |
|
√ |
√ |
|
√ |
× |
|
√ |
√ |
|
√ |
√ |
|
√ |
× |
|
√ |
× |
|
√ |
× |
|
√ |
× |
|
√ |
√ |
API 请求方法¶
TSDB数据服务API V2.1支持POST请求方法，请求参数除 orgId以外，以JSON格式包含在请求体中。
SDK示例推荐Poseidon版本：
<dependency>
<groupId>com.envisioniot</groupId>
<artifactId>apim-poseidon</artifactId>
<version>0.1.14</version>
</dependency>
通用错误码
代码 |
错误信息 |
描述 |
|---|---|---|
0 |
OK |
API调用成功。 |
80400 |
Invalid param error |
存在不正确的请求参数，具体信息请查看error message。 |
80401 |
Assset unauthorized |
没有对设备的访问权限，检查对服务账号SA的授权。 |
80500 |
Internal server error |
服务内部错误。 |