EnOS 通用数据服务 API 常见问题¶
如何获取 Access Key(accessKey
)信息¶
accessKey
是 EnOS 分配给应用的服务账号,用于对应用进行鉴权。accessKey
通过注册应用获取。如需获取该信息,执行以下操作:
在 EnOS 管理控制台左侧导航栏中点击 应用注册。
选择需调用 API 的应用,查看基本信息中的 AccessKey。
如何获取组织 ID(orgId
)信息¶
在 EnOS 管理控制台左侧导航栏中点击 身份与授权 > 组织信息。组织 ID 即为 orgId
。
如何获取对象类型标识符(mdmTypes
)信息¶
在 EnOS 应用门户中选择 通用数据服务,并在左侧导航栏中点击 业务对象类型。对象类型标识符 即为 mdmTypes
。
如何获取记录类型标识符(recordTypes
)信息¶
在 EnOS 应用门户中选择 通用数据服务,并在左侧导航栏中点击 业务对象要素 > 记录类型。记录类型标识符 即为 recordTypes
。
如何获取拓扑规则标识符(topologyRuleId
)信息¶
使用通用数据服务的资产拓扑规则查询接口获取 topologyRuleId
。有关具体的查询方法,参见 Query Asset Topology Rule。
如何获取测点标识符(pointId
)信息¶
通用数据服务 API 既支持查询已注册设备类型中的全量模型测点,也支持查询自定义的虚拟测点。
虚拟测点:在 EnOS 应用门户中选择 通用数据服务,并在左侧导航栏中点击 业务对象要素 > 虚拟测点。测点标识符 即为
pointId
。模型测点:按照以下步骤查询模型测点。
在 EnOS 管理控制台左侧导航栏中点击 资产树,选择目标资产树,搜索想要查询的设备名称。
点击设备,右侧测点栏中的测点名称对应的标识符即为
pointId
。
如何获取属性标识符(attributes
)信息¶
通用数据服务 API 既支持查询已注册设备类型中的全量模型属性,也支持查询自定义的虚拟属性。
虚拟属性:在 EnOS 应用门户中选择 通用数据服务,并在左侧导航栏中点击 业务对象要素 > 虚拟属性。属性标识符 即为
attributes
。模型属性:按照以下步骤查询模型属性。
在 EnOS 管理控制台左侧导航栏中点击 资产树,选择目标资产树,搜索想要查询的设备名称。
点击设备,右侧属性栏中的属性名称对应的标识符即为
attributes
。
如何获取指标标识符(metrics
)信息¶
在 EnOS 应用门户中选择 通用数据服务,并在左侧导航栏中点击 业务对象要素 > 业务指标。通用数据服务支持传入 指标标识符 或 标准标识符 作为 metrics
查询指标数据。
如何获取维度标识符(dimensions
)信息¶
在 EnOS 应用门户中选择 通用数据服务,并在左侧导航栏中点击 业务对象要素 > 维度类型。维度标识符 即为 dimensions
。
备注
通过以下方法确定待查询的指标是否支持按特定维度进行聚合:
进入 业务对象要素 > 业务指标 菜单,查看待查询指标的 聚合维度 栏,确认是否有对应的维度类型标识符。没有则表明该指标不支持按该维度进行聚合查询。
进入 业务对象要素 > 业务指标 菜单,在指标列表中筛选 聚合维度名称,获取支持按特定维度聚合查询的业务指标列表,确认是否有对应的指标。