API

在 EnOS 2.1 Update Release 发布中,我们新增了以下API和API服务。

接入服务

API名称

描述

Upload Attributes

上传包括文件类型在内的属性数据

Upload Events

上传包括文件类型在内的事件数据

Upload Measurement Points

上传包括文件类型在内的测点数据

Download File

下载某个设备上传的文件

Delete File

删除某个设备上传的文件

Apply Certificate

申请证书并绑定至指定设备

Renew Certificate

为证书过期的设备申请新证书并绑定至设备

Search Device

新增支持按照设备属性、标签进行搜索;并新增了对批量搜索的支持

TSDB数据服务

API版本升级

从本次发布起,TSDB数据服务 API版本升级为 v2.1。新版本包含以下新功能及变更:

新增/变更项

更新前

更新后

影响范围

新增请求参数

localTimeFormat

所有接口

新增请求参数

itemFormat

所有接口

请求方法

GET/POST

POST

所有接口

请求/返回参数名称变更

measurepoints

pointIds

所有接口

请求/返回参数名称变更

meaurepointsWithLogic

pointIdsWithLogic

所有接口

请求/返回参数名称变更

meaurepoint

pointId

所有接口

返回字段重命名

status

code

所有接口

调用成功返回值重命名

Success

OK

所有接口

新增API

API名称

描述

Delete Asset Latest Data

删除指定设备、测点的最新数据

TSDB策略服务

API名称

描述

Get Storage Policy

根据存储策略ID,获取指定存储策略的详细信息

Save Storage Policy

根据存储策略ID,更新并保存指定存储策略的配置信息

IAM 服务

API名称

描述

Log In

登录EnOS

Get Session Information

获取会话信息

List User Organization

列出用户所在组织

Application Portal服务

API名称

描述

Get Users with Asset Access

获取对某一资产有权限的用户列表

Get Unresolved Messages

获取未确认的应用消息列表

Get User Domain

通过用户邮箱地址获取用户所在的域信息

Get User Structures

获取用户所分配的组织结构节点

Log In Via Authorization Code

通过授权码登陆

批处理服务

从本次发布起,数据流服务(Dataflow Service) 更名为 批处理服务(Batch Processing Service)。请求URL中 dataflow-batch-service 更改为 batch-processing-service,API版本升级为 v2.1。新版本包含以下更新:

修订项

更新前

更新后

影响范围

返回字段重命名

status

code

所有接口

调用成功返回值重命名

Success

OK

所有接口

searchValue 字段重命名

searchValue

expression

Get My Flow

pagination 结构体

pageNo 起始值从0开始

pageNo 起始值从1开始

Search Flow,List Flow Instances

数据联邦服务

API名称

描述

List Channels

查询组织内已创建的数据读取通道和数据写入通道

Read Data

通过指定通道,使用SQL语句读取数据

List Jobs

查询与指定通道相关联的数据读取任务或写入任务

Get Job Details

获取数据读取任务或写入任务的详细信息

Write Message

通过指定通道,向数据源写入消息数据

Write Chunk File

通过指定通道,向数据源写入块文件

流数据处理服务

API名称

描述

Get Stage State

查询指定流数据处理任务中某个指定算子的中间状态数据

Delete Stage State

删除指定流数据处理任务中某个指定算子的中间状态数据