检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 通过使用工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)所提供的接口,您可以完整的使用iDME的所有功能。 调试 您可以在API Explorer中调试接口。 接口说明 表1 iDME接口说明 类型 说明 应用管理 包括应用的创建、删除、编辑等接口。
API 应用管理 运行服务管理 数据建模引擎
在“分类”操作栏中,根据实际业务需求,导出全部数据模型API或者选中的数据模型API。 全部导出:单击“导出批量操作 > 全部导出”。 图1 全部导出 导出选中项:勾选需要导出的API或分类,单击“导出批量操作 > 导出选中项”。 图2 导出选中项 在弹出的窗口中,选择导出文件的保存路径,单击“保存”。 “swagger
查询指定API 操作场景 默认情况下,应用设计态的“数据服务管理 > 全量数据服务”展示的是当前应用下用户构建数据模型时预生成的接口。为了帮助用户快速搜索预生成的数据模型接口,工业数字模型驱动引擎-数据建模引擎(xDM Foundation,简称xDM-F)提供搜索功能,您在搜索
查看设备API 操作场景 本文指导您如何查看当前选择的应用租户下的所有设备API。 操作步骤 登录LinkX-F系统首页。 选择“基础数据管理 > 设备API”,进入“设备API”页面。 列表默认展示所有设备API。如有需要,您还可: 筛选设备API:在“条件筛选”处输入或选择常用查询条件,单击“搜索”。
设备API 创建设备API 查看设备API 修改设备API 删除设备API 父主题: 基础数据管理
修改设备API 操作场景 您可根据需要更新设备API信息。本文指导您如何修改设备API。 如果待修改的设备API有被数据实体映射引用,则只支持修改部分字段。 前提条件 已获取开发人员及以上权限用户的账号和密码。 操作步骤 登录LinkX-F系统首页。 选择“基础数据管理 > 设备API”,进入“设备API”页面。
发布聚合服务后生成的API如何调用? 调用服务 聚合服务发布成功后,您可根据业务需要调用已发布的API接口。调用方在目标服务的“服务发布”页签中获取相应的API调用信息后,可通过API方式调用服务编排。 图1 获取API调用信息 API调用信息:包括生产环境API调用链接和验证环境
删除设备API 操作场景 如果设备API不再使用,您可选择删除。本文指导您如何删除设备API。 如果待删除的设备API中有被数据实体映射引用,则不支持删除。 前提条件 已获取开发人员及以上权限用户的账号和密码。 操作步骤 登录LinkX-F系统首页。 选择“基础数据管理 > 设备API”,进入“设备API”页面。
基于已发布的模型路径生成API服务 操作场景 基于已发布的模型路径探索可以配置聚合服务,通过该方式,您可快速生成对应的API,其状态处在正在工作中。 通过此方式生成的API为非纯脚本服务,且脚本类型为JavaScript。 前提条件 已获取开发人员及以上权限用户的账号和密码。 操作步骤
查看API详情 操作场景 当您发布数据模型和发布应用后,系统会在全量数据服务中预生成与其相应的API,您可以在应用设计态预览各类API的详细信息。 支持通过如下方式进行查看: 离线方式:将应用设计态的全量数据服务API导出至本地计算机进行查看(推荐),具体操作请参见导出API。 在线方式:在应用设计态上在线查看。
可以通过API方式使用应用设计态吗? 工业数字模型驱动引擎-数据建模引擎(xDM Foundation,简称xDM-F)的应用设计态仅支持可视化、无码化的前端页面进行数据建模;应用运行态开放应用下所有API,支持用户通过可视化前端页面和API方式使用xDM-F。 父主题: 数据建模引擎相关问题
如何调用API 构造请求 认证鉴权 返回结果
根据源系统API是否被数据实体或关系实体映射引用情况不同,支持修改的信息有所不同,区分如下: 如果所选源系统API未被映射引用,所有信息均可修改。 如果所选源系统API有被映射引用,则除“API描述”和“请求头”外的其他信息均禁止修改。 单击“API名称”链接,在弹出的详情页底部单击“编辑”。
查看源系统API 操作场景 本文指导您如何查看当前选择的应用租户下的所有源系统API。 操作步骤 登录LinkX-F系统首页。 选择“基础数据管理 > 源系统API”,进入“源系统API”页面。 列表默认展示所有源系统API。如有需要,您还可: 筛选源系统API:在“条件筛选”处
是否批量接口 是否是查询批量设备OT数据的接口。 默认值为“否”。 API英文名称 设备API的英文名,必填且不能重复,必须以大写字母开头,且只能包含字母、数字、下划线。 API中文名称 设备API的中文名,非必填,必须以中文或者字母开头,且只能包含中文、字母、数字、下划线。 API
全量数据服务中的API支持导出吗? 工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)提供导出全量数据服务功能,您可以根据实际业务需求导出设计态或运行态下的全量数据。具体操作请参见: 全量数据服务(设计态) 全量数据服务(运行态)
删除源系统API 操作场景 如果源系统API不再使用,您可选择删除。本文指导您如何删除源系统API。 如果待删除的源系统API中有被数据实体或关系实体映射引用,则不支持删除。 前提条件 已获取开发人员及以上权限用户的账号和密码。 操作步骤 登录LinkX-F系统首页。 选择“基础数据管理
单击“创建”,弹出“创建源系统API”页面。 填写基本信息,如表1所示: 表1 基本信息 字段 说明 API类型 必填,下拉选择API类型: 普通API:代表无外键依赖的实体数据API,包括源端API和对象实体API。 外键依赖API:代表外键依赖的实体数据API。 纯关系API:代表至少存在两
源系统API 创建源系统API 查看源系统API 修改源系统API 删除源系统API 父主题: 基础数据管理