更新API


该部分介绍了在 EnOS 2.1 Release 发布中的API行为变更。

模型服务

API名称

更新内容

Get Thing Model

在响应的 data 对象的以下结构体中,增加了 isStdElementstdElementId 字段:

  • ThingEvent

  • ThingService

  • ThingMeasurepoint

  • ThingAttribute

  • ThingDatapoint

Search Thing Model

在响应的 data 对象的以下结构体中,增加了 isStdElementstdElementId 字段:

  • ThingEvent

  • ThingService

  • ThingMeasurepoint

  • ThingAttribute

  • ThingDatapoint

Search Thing Model

请求参数(URI)中的查询表达式(expression)所支持的查询字段 tags 新增支持算术运算符exists和not exists。

接入服务

API名称

更新内容

Search Device

请求参数(Body)中的查询表达式(expression)新增支持查询 deviceTags 字段。

Search Product

请求参数(Body)中的查询表达式(expression)新增支持查询 productTags 字段。

Get Device

Device结构体中新增四个参数:measurepointLastUpdateeventLastUpdateattributeLastUpdatefeatureLastUpdate,用以表示设备最近更新时间。

Create Product

请求参数(Body)中新增支持 dynamicActivateEnabledproductTags 两个可选参数。

  • dynamicActivateEnabled:用于表示创建的产品是否允许动态激活

  • productTags:用于表示产品标签

Update Product

请求参数(Body)中新增支持可选参数 productTags,用于表示产品标签

资产树服务

API名称

更新内容

Search Asset Node

在请求参数(Body)中,新增 expression 参数,代替原先的 filter 参数。

告警服务

API名称

更新内容

Create Active Alert

在请求参数 ActiveAlert结构体 中里新增 deviceStatus 参数

Create Alert Rule

在请求参数里新增 deviceStatus 参数

Create History Alert

在请求参数 HistoryAlert结构体 中里新增 deviceStatus 参数

Search Active Alert

  • 请求参数(Body)中的 expression 参数新增对 deviceStatusassetPath 字段的查询

  • 响应参数 ActiveAlert 结构体中的参数 value 支持记录 triggeringDelayTimer 开始计时时测点的值。

Search Alert Rule

  • 在请求参数(Body)中里新增 deviceStatus 参数

  • 参数 expression 支持对 deviceStatus 的查询,支持“!=”语法

  • 返回参数中新增 ``deviceStatus``参数。

  • 响应参数 AlertRule 结构体中新增参数 triggeringDelayTimer,表示告警被延后触发的时间。

Search History Alert

  • 请求参数(Body)中的 expression 参数新增对 deviceStatusassetPath 字段的查询

  • 返回参数中新增 deviceStatus

  • 功能变更为查询 最近三个月内 的历史告警。

  • 响应参数 HistoryAlert 结构体中的参数 value 支持记录 triggeringDelayTimer 开始计时时测点的值。

Aggregate Active Alerts

请求参数(Body)中的查询表达式(expression)所支持的查询字段 tag 新增支持算术运算符exists和not exists。

Create Alert Content

  • 移除请求参数(Body)中的 source 参数。

  • 响应参数 data 的数据类型由原先的null改为String;

  • 请求参数(Body)中新增 source 参数,用以表明告警内容适用的数据源。

Create Alert Rule

  • 移除请求参数(Body)中的 source 参数。

  • 响应参数 data 的数据类型由原先的null改为String;

  • 请求参数(Body)中的 condition 参数调整为类查询表达式;

  • 请求参数(Body)中新增 source 参数,用以表明告警规则适用的数据源。

  • 请求参数(Body)中新增参数 triggeringDelayTimer, 用于设定延后告警触发时间。

Create Alert Severity

  • 移除请求参数(Body)中的 source 参数。

  • 响应参数 data 的数据类型由原先的null改为String;

  • 请求参数(Body)中新增 source 参数,用以表明告警级别适用的数据源。

Create Alert Type

  • 移除请求参数(Body)中的 source 参数。

  • 响应参数 data 的数据类型由原先的null改为String;

  • 请求参数(Body)中新增 source 参数,用以表明告警类型适用的数据源。

Delete Alert Content

  • 移除请求参数(URI)中的 source 参数。

  • 请求参数(URI)中新增 source 参数,用以表明告警内容适用的数据源。

Delete Alert Rule

  • 移除请求参数(URI)中的 source 参数。

  • 请求参数(URI)中新增 source 参数,用以表明告警规则适用的数据源。

Delete Alert Severity

  • 移除请求参数(URI)中的 source 参数。

  • 请求参数(URI)中新增 source 参数,用以表明告警级别适用的数据源。

Delete Alert Type

  • 移除请求参数(URI)中的 source 参数。

  • 请求参数(URI)中新增 source 参数,用以表明告警类型适用的数据源。

Search Active Alerts

  • 请求参数(Body)中的查询表达式(expression)所支持的查询字段 tag 新增支持算术运算符exists和not exists。

  • 请求参数(Body)中新增支持 scoperootAlert 两个可选参数。

Search Alert Content

  • 移除响应参数 AlertContent 结构体中的 source 参数。

  • 响应参数 AlertContent 结构体中新增 source 参数,用以表明告警内容适用的数据源。

Search Alert Rule

  • 移除响应参数 AlertRule 结构体中的 source 参数。

  • 响应参数 AlertRule 结构体中新增 source 参数,用以表明告警规则适用的数据源。

Search Alert Severity

  • 移除响应参数 AlertSeverity 结构体中的 source 参数。

  • 响应参数 AlertSeverity 结构体中新增 source 参数,用以表明告警级别适用的数据源。

Search Alert Type

  • 移除响应参数 AlertType 结构体中的 source 参数。

  • 响应参数 AlertType 结构体中新增 source 参数,用以表明告警类型适用的数据源。

Search History Alerts

  • 请求参数(Body)中的查询表达式(expression)所支持的查询字段 tag 新增支持算术运算符exists和not exists。

  • 请求参数(Body)中新增支持 scoperootAlert 两个可选参数。

Update Alert Content

  • 移除请求参数(Body)的 generateContent 结构体中的 source 参数。

  • 请求参数(Body)的 generateContent 结构体中新增 source 参数,用以表明告警内容适用的数据源。

Update Alert Rule

  • 在请求参数(Body)中新增 deviceStatus 参数

  • 将原来 alertRule结构体 中的参数合并入请求参数(Body)

  • 移除请求参数(Body)的 alertRule 结构体中的 source 参数。

  • 请求参数(Body)中的 condition 参数调整为类查询表达式;

  • 请求参数(Body)的 alertRule 结构体中新增 source 参数,用以表明告警规则适用的数据源。

  • 请求参数(Body) alertRule 结构体中新增参数 triggeringDelayTimer, 用于设定延后告警触发时间。

Update Alert Severity

  • 移除请求参数(Body)的 generateSeverity 结构体中的 source 参数。

  • 请求参数(Body)的 generateSeverity 结构体中新增 source 参数,用以表明告警级别适用的数据源。

Update Alert Type

  • 添加限制条件,如果告警类型已经有了父告警类型,则该父告警类型不能被修改

  • 移除请求参数(Body)的 generateType 结构体中的 source 参数。

  • 请求参数(Body)的 generateType 结构体中新增 source 参数,用以表明告警类型适用的数据源。

TSDB数据服务

API名称

更新内容

Filter Asset Latest Data

支持POST请求方法

Get Asset AI Data with Aggregation Logic

支持POST请求方法

Get Asset AI Raw Data

  • 支持POST请求方法

  • 在请求参数(URI)中,新增 withQuality 参数,用于获取数据质量位。

Get Asset Current Day Electric Power

支持POST请求方法

Get Asset DI Data

  • 支持POST请求方法

  • DI数据获取接口增加首值插补功能。

Get Asset DI Data Duration

支持POST请求方法

Get Asset Electric Power Data

支持POST请求方法

Get Asset Generic Data

  • 支持POST请求方法

  • 在请求参数(URI)中,新增 withQuality 参数,用于获取数据质量位。

Get Asset Latest Data

支持POST请求方法

Get Asset Raw Data By Time Range

  • 支持POST请求方法

  • 请求参数新增 orderBy,用于将返回结果按照某字段排序

  • 在请求参数(URI)中,新增 withQuality 参数,用于获取数据质量位。

其他

项目

更新内容

Token认证

引导用户生成Access Token,使用Access Token调用API