API 变更¶
该部分介绍了在 EnOS 2.4 中的 API 行为变更。
EnOS 通用 API¶
以下介绍在 EnOS 2.4 中部分通用 API 的使用限制变更。
服务/功能模块 | 变更前 | 变更后 | 影响分析 |
---|---|---|---|
模型服务 | 属性的 dataType 为 string:最长 1024 字符 |
属性的 dataType 为 string:最长 4000 字符 |
无 |
接入服务 > 产品 | productDesc :最长 100 字符 |
productDesc :最长 512 字符 |
无 |
接入服务 > 固件管理 | desc :最长 100 字符 |
desc :最长 512 字符 |
无 |
资产树服务 > 资产树 | tags :单个资产树最多可添加 50 标签 |
tags :单个资产树最多可添加 100 标签 |
无 |
以下介绍在 EnOS 2.4 中部分通用 API 需授权的资源和操作权限变更。
API 名称 | 变更前 | 变更后 | 影响分析 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|---|---|
模型服务 > Update Thing Model |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Create Product |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Delete Product |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Update Product |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Apply Certificate |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Renew Certificate |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Revoke Certificate |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > List Certificate |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Create Firmware File |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Delete Firmware |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Create OTA Job |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
接入服务 > Delete OTA Job |
|
|
原有服务账号权限已同步更新,无影响 | √ | × |
以下介绍在 EnOS 2.4 中部分通用 API 的 EnOS Edge 适用能力变更。
服务/功能模块 | API 名称 | 变更前 | 变更后 | 影响分析 |
---|---|---|---|---|
接入服务 > 设备数据 | Get Latest Measurement Points | 不适用于 EnOS Edge | 支持调用该 API 获取 EnOS Edge 设备上传的最新测点数据 | 无影响 |
接入服务 > 设备 | Search Device | 不适用于 EnOS Edge | 支持调用该 API 查询 EnOS Edge 设备信息 | EnOS Edge 简化了部分请求参数和返回参数,具体内容参见 API 文档 |
接入服务 > HTTP 消息集成 | Upload Measurement Points | 不适用于 EnOS Edge | 支持调用该 API 上传 EnOS Edge 设备的测点数据,但不包括文件类型的测点数据 | 无影响 |
告警引擎服务 > 告警内容 | Get Alert Content | 适用于 EnOS Edge,但 EnOS Edge 不支持 OU 校验 | EnOS Edge 对该接口支持 OU 校验 | 无影响 |
告警引擎服务 > 告警规则 | Search Alert Rule | 不适用于 EnOS Edge | 支持调用该 API 查询 EnOS Edge 设备配置的告警规则 | 无影响 |
告警引擎服务 > 告警记录 > 历史与当前告警记录 | 不适用于 EnOS Edge | 支持调用这些 API(批量)创建、查询 EnOS Edge 设备的当前活历史告警或关闭当前告警 | 无影响 | |
告警引擎服务 > 告警记录 > 告警标签 | 不适用于 EnOS Edge | 支持调用 API 对由 EnOS Edge 设备触发的告警记录的标签内容进行(批量)更新 | 无影响 |
模型服务¶
API 名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Get Thing Model 和 Search Thing Model | 为 ThingDatapoint Struct 新增 isRequired 和 defaultValue 参数。 |
√ | × |
Update Thing Model | 为 ThingDatapoint Struct 新增 isRequired 和 defaultValue 参数,以指定在调用服务时是否需要输入参数的值以及其默认值。 |
√ | × |
接入服务¶
API 名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Search OTA Job | expression 参数支持 name 和 firmwareName 的语言模糊查询。 |
√ | × |
资产树服务¶
API 名称 | 描述 | 适用于 EnOS Cloud | 适用于 EnOS Edge |
---|---|---|---|
Delete Asset Node | 新增 force 请求参数,使用户能够从资产树中删除一个节点以及其所有子节点。 |
√ | × |