新增API


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

模型服务

API名称

描述

Search Thing Model

ThingAttribute结构体ThingMeasurepoint结构体ThingDatapoint结构体 中新增 dataDefinition 参数,用于定义结构体内 datatype 参数所表示的数据类型。

接入服务

API名称

描述

Apply Certificate

申请证书并绑定证书到指定的设备上

Renew Certificate

更新证书,并将新证书与设备进行绑定

Revoke Certificate

撤销设备绑定的证书

List Certificate

显示设备绑定的证书列表

Search Command

查询命令详情信息。

Replace Device

在资产ID(assetId)不改变的情况下更换一个设备的Device Key。

资产树服务

API名称

描述

Create Asset Tree

创建一棵资产树,并同时创建该资产树的根节点

Create Asset Tree and Associate Asset

创建一个资产树,并关联一个已有的资产作为其根节点

Delete Asset Tree

删除一个资产树

Update Asset Tree

更新资产树的信息

告警服务

API名称

描述

Create Active Alerts in Batch

批量创建当前告警

Create History Alerts in Batch

批量创建历史告警

Create Alert Type

请求参数(Body)``generateType`` 结构体中新增参数 parentTypeId, 用于表示父告警类型编号。

Update Alert Type

请求参数(Body)``generateType`` 结构体中新增参数 parentTypeId, 用于表示父告警类型编号。

Close Active Alert

关闭当前告警。

Search Alert Rule

查询告警规则。

Batch Update Active Alert Tags

批量更新指定告警的标签

Create Alert Rule

创建一条告警规则

Update Alert Rule

更新告警规则

Update Alert Rule

更新告警规则

Delete Alert Rule

删除组织下指定告警规则

Create Alert Content

创建告警内容

Update Alert Content

更新告警内容

Delete Alert Content

删除告警内容

Create Alert Severity

创建一条告警级别

Update Alert Severity

更新告警级别

Delete Alert Severity

删除告警级别

Create Alert Type

创建一条告警类型

Update Alert Type

更新告警类型

Delete Alert Type

删除告警类型

Create Active Alert

创建当前告警

Delete Active Alert

删除指定告警

Create History Alert

创建历史告警

TSDB数据服务

API名称

描述

Get Asset DI Data Duration

获取指定设备的指定测点在一段时间内不同状态的时长统计

IAM服务

API名称

更新内容

Get Organization

获取组织信息

Application Portal 服务

API名称

描述

Get User’s Applications

通过Access Token获取当前用户有权限的应用的列表

Authorize Asset

将在EnOS平台上新建的电站授权给创建人

Check Asset Permission

查看是否有资产的权限

Choose Organization

用户在登录后选择需要进入使用的组织

Create Message

创建消息

Get App Menu and Permission

获取应用的权限点及菜单列表

Get Assets by Application

获取当前用户在某个应用下有权限的所有资产

Get Assets by Organization

获取指定用户在指定组织下有权限的所有资产

Get Asset Structure

获取资产所在的组织的上游组织结构

Get Colors of the Message Icon

获取消息图标可选择配置的颜色集合

Get Manageable User List

获取当前账号权限下可管理的所有用户列表

Get Message Ringtones

获取消息可选择配置的提示声集合

Get Organization List

根据Access Token列出当前用户所在的组织列表

Get Organization User List

不登录Application Portal的状态下授权应用获取指定组织下所有用户列表

Get Token Information

获取Access Token所对应的当前登录用户的相关信息

Get User Information

获得当前用户的信息

Log In

登录账号

Log Out

登出账号

Refresh Access Token

使用Refresh Token请求一个新的Access Token

Revoke Refresh Token

撤销用户所有的Refresh Token

Sync Asset

将在EnOS平台上标有指定标签的资产同步到Application Portal

Update Message

更新消息状态

预测模型服务

API名称

描述

Machine Learning Forecast

“预测类”机器学习算法模型部署成功后,根据部署的预测模型,获取机器学习预测结果。

数据流服务

API名称

描述

Cancel Flow Instance

终止指定任务流实例的运行

Create Directory

创建目录

Delete Flow

删除指定的任务流

Disable Flow

暂停任务流调度

Enable Flow

启动任务流调度

Export Flow

导出任务流到本地

Get Current Time

获取服务器当前时间

Get Flow

获取指定ID的任务流信息

Get Flow Instance

获取指定的任务流实例信息

Get My Flow

模糊查询满足指定条件的所有任务流信息

Get Task Instance Log

获取指定任务实例的日志信息

Get Time Zone

获取服务端所在位置的时区

Import Flow

从本地任务流文件导入任务流,任务流以指定的名称保存在指定的目录下

List Flow Instances

查询满足条件的所有任务流实例

List Workflow Directories

获取当前用户所属组织workflow目录下的所有内容(包括子目录和任务流文件)

Load Flow For Edit

将指定任务流同步到临时任务流,并获取该任务流信息

Save Flow

保存当前任务流

Search Flow

分页查询符合条件的所有任务流

Trigger Flow

手动触发一次任务调度

Update And Trigger Flow

使用新的参数触发一次任务流调度(不改变原workflow的信息,只使用新的参数生成一个任务流实例)