新增 API¶

在 EnOS 2.4 中，我们对 EnOS API 进行了重新分类，分为通用 API 和语义 API:

通用 API 是 EnOS 各核心业务流程中原生数据的 API 接口。我们在通用 API 新增了多项 API 服务，并在部分原有 API 服务中新增了多项 API。
语义 API 是基于业务语义将数据统一化、标准化后再输出的 API 接口。我们在语义 API 新增了接入工具服务和通用数据服务两项新 API 服务。

EnOS 通用 API¶

在 EnOS 2.4 中，我们在通用 API 新增了设备预配置服务、指标管理服务、工作管理服务，并为部分原有 API 服务新增了多项 API。“√” 和 “×” 分别指该 API 是否适用于 EnOS Cloud/EnOS Edge。

在 EnOS 2.4 中，我们在通用 API 新增了下列 API 服务。

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Create DPS Device	创建 DPS 设备	√	×
Get DPS Device	获取 DPS 设备信息	√	×
Allocate DPS Device	分配与激活 DPS 设备	√	×
Reset Device Allocation Status	重置设备分配状态	√	×

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Query Metric Data	批量查询指标数据	√	×

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Get Service Request List	获取服务请求列表	√	√
Get Service Request Details	获取服务请求详情	√	√
Get Work Order List	获取工单列表	√	√
Get Work Order Details	获取工单详情	√	√
Get Relation List/Downtime	获取关联记录/停机记录详情	√	√

在 EnOS 2.4 中，我们在下列通用 API 服务中新增了多项 API。

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Create SSO User	创建 SSO 用户	√	×
Update SSO User	更新 SSO 用户信息	√	×
List SSO Users	获取指定组织的 SSO 用户列表信息	√	×
Delete SSO User	将 SSO 用户从组织中删除	√	×
List Policies by User	获取用户绑定的策略列表	√	×
List User Groups by User	获取用户在当前组织加入的用户组列表	√	×
Create User Group	创建用户组	√	×
Update User Group	更新用户组信息	√	×
Get User Group	获取用户组详细信息	√	×
List User Groups	获取组织下的用户组列表	√	×
Delete User Group	将用户组从组织中删除	√	×
Add User to User Group	将用户加入用户组	√	×
Remove User from User Group	将用户从用户组中移除	√	×
Attach Policy to User/User Group/Service Account	给用户/用户组/服务账号绑定策略	√	×
Remove Policy from User/User Group/Service Account	取消用户/用户组/服务账号绑定的策略	√	×
Get Policy	获取策略详细信息	√	×
List Policies by Service Account	获取服务账号绑定的策略列表	√	×
List Policies	获取组织下的策略列表	√	×
Get Resource	获取资源的信息	√	×
Get Resource Condition	根据资源的类型获取此资源的可筛选条件	√	×
Get Resource Provider	根据资源的类型获取此资源的提供方信息	√	×
Get Resource Operation Permissions	根据资源的类型获取此资源可选的权限操作	√	×

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Get Asset Unified Raw Data	用于查询标准数据和非标准数据的统一接口，支持标准数据的插补	√	×

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Get Asset Unified Raw Data	用于查询标准数据和非标准数据的统一接口，支持标准数据的插补	√	×

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Import Entity by Excel	通用的导入 Entity 接口，支持使用 Excel 格式的文件导入数据。	√	×
Import Relationship by Excel	通用的导入 Relationship 接口，支持使用 Excel 格式的文件导入数据。	√	×
Export Entity to Excel	通用的导出 Entity 接口，支持将导出的数据保存为 Excel 格式的文件。	√	×
Export Relationship to Excel	通用的导出 Relationship 接口，支持将导出的数据保存为 Excel 格式的文件。	√	×

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Create Message Rule	创建消息规则	√	√
Delete Message Rule	删除消息规则	√	√
Search Message Rule	查询消息规则	√	√
Update Message Rule	修改消息规则	√	√
Get Application Resources by User and Organization	获取应用的权限点及菜单列表	√	√
Confirm Password	确认已登陆用户的密码	√	√
Assign Assets to Organization Structure	将资产挂载到组织结构节点	√	√
Create Organization Structure	创建组织结构节点	√	√
Create User and Choose Organization	创建用户并为该用户分配组织	√	√
Delete Organization Structure	删除组织结构节点	√	√
Get Organization User Group List	获取组织内用户组列表	√	√
Get Structure by Application	获取应用下挂载的组织结构根节点	√	√
Get Structure by Detail	获取应用下挂载的完整组织结构节点	√	√
Get Structure by User	获取用户有权查看的组织结构	√	√
Get User by User Group	获取用户组的用户列表	√	√
Query Audit Logs	查询审计日志记录	√	√
Query Menu Access Logs	查询用户的访问菜单操作	√	√
Update Organization Structure	修改组织结构节点	√	√
Update User Information	更新用户信息	√	√

在 EnOS 2.4 中，我们在语义 API 新增了接入工具服务和通用数据服务两项新 API 服务。“√” 和 “×” 分别指该 API 是否适用于 EnOS Cloud/EnOS Edge。

以下是 EnOS 2.4 中新增的语义 API 服务。

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Search Site	查询场站的基本信息	√	×
Search Device	查询全部或指定场站下设备的基本信息	√	×
Search Topology	查询场站内拓扑结构的基本信息	√	×
Search Topology Path	查询拓扑结构从根到最末的节点路径，并返回路径中所有节点的信息	√	×
Get Topology Definition	获取拓扑结构的元数据，以及拓扑规则允许的设备类型等信息	√	×

API 名称	描述	适用于 EnOS Cloud	适用于 EnOS Edge
Query Meta Attribute	获取属性元数据	√	√
Query Meta Measurement Point	获取测点元数据	√	√
Query Meta Metric	获取指标元数据	√	√
Query Meta Generic Data	获取通用元数据	√	√
Query Meta Record	获取记录元数据	√	√
Query Accessible Asset Type	获取可访问的资产类型列表	√	√
Query Accessible Asset	获取可访问的资产列表	√	√
Query Asset Attribute	获取指定资产的属性	√	√
Query Asset Hierarchy	获取指定资产的层级关系	√	√
Query Asset Topology	获取指定资产的拓扑关系	√	√
Query Asset Topology Rule	获取资产拓扑规则	√	√
Query Latest Measurement Point	获取最新的测点读数	√	√
Query Latest Metric	获取最新的指标数据	√	√
Query Historical Measurement Point	获取测点的时序数据	√	√
Query Historical Metric	获取指标的历史数据	√	√
Query Record	获取第三方记录数据	√	√