资产树服务 API 概述¶
资产树是资产与资产之间层级关系的一种组织方式。有关资产树的信息,参见 资产树概览。
通过资产树服务 API,设备接入和管理人员可以创建、更新、删除、查询资产树及其节点。关于资产树服务 API 的完整接口列表及功能说明,参见 有关 EnOS API。
前提条件¶
API 列表
¶
你可以通过下表了解可以调用资产树服务 API 执行哪些操作,每项操作对应的 URL,以及是否适用于 EnOS Cloud 和 EnOS Edge。
资产树¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
---|---|---|---|---|
创建一棵资产树,并新建一个逻辑资产,关联到该资产树的根节点 |
/asset-tree-service/v2.1/asset-trees?action=create |
√ |
× |
|
创建一棵资产树,并关联一个已有的资产作为其根节点 |
/asset-tree-service/v2.1/asset-trees?action=associate |
√ |
× |
|
删除一个资产树 |
/asset-tree-service/v2.1/asset-trees?action=delete |
√ |
× |
|
获取资产树信息 |
/asset-tree-service/v2.1/asset-trees?action=get |
√ |
√ |
|
搜索符合条件的资产树 |
/asset-tree-service/v2.1/asset-trees?action=search |
√ |
√ |
|
更新资产树的信息 |
/asset-tree-service/v2.1/asset-trees?action=update |
√ |
× |
资产树节点¶
操作名称 |
描述 |
URL |
适用于 EnOS Cloud |
适用于 EnOS Edge |
---|---|---|---|---|
将一个已有资产关联到资产树上 |
/asset-tree-service/v2.1/asset-nodes?action=associateAsset |
√ |
× |
|
将已有资产批量关联到资产树上 |
/asset-tree-service/v2.1/asset-nodes?action=associateAssetBatch |
√ |
× |
|
创建一个逻辑资产,并关联到资产树上 |
/asset-tree-service/v2.1/asset-nodes?action=createAsset |
√ |
× |
|
移动一个节点连同其子节点到一个指定的位置 |
/asset-tree-service/v2.1/asset-nodes?action=move |
√ |
× |
|
从资产树上移除一个节点及其关联的资产 |
/asset-tree-service/v2.1/asset-nodes?action=delete |
√ |
× |
|
根据一组资产 ID 搜索资产所在的资产树 |
/asset-tree-service/v2.1/asset-nodes?action=getAssetTree |
√ |
√ |
|
查询满足条件的资产 |
/asset-tree-service/v2.1/asset-nodes?action=searchAsset |
√ |
√ |
|
查询指定资产树上的资产,可指定相对于某个已知资产的关系作为查询条件 |
/asset-tree-service/v2.1/asset-nodes?action=searchRelatedAsset |
√ |
√ |
|
查询资产树上符合条件的路径 |
/asset-tree-service/v2.1/asset-paths?action=search |
√ |
√ |
SDK 示例¶
你可以在 Github 上获取资产树服务 API 的 SDK 示例: