# 华为云数字工厂 华为云数字工厂连接器把数字工厂平台自身丰富的能力通过API的形式对外开放，包括各模型数据管理（空间、产品、过程、事务、组织、人员、辅助模型）、分析数据集\&统计指标结果、获取标识模型值、数字字典列表等，帮助用户快速构筑基于数字工厂平台的行业应用。 该连接器包含如下执行动作： - [创建模型实例数据] - [查询模型实例数据列表] - [查询模型实例数据] - [修改模型实例数据] - [删除模型实例数据] #### 连接参数 连接器使用数字工厂分配的client_id和client_secret认证方式，连接前需要先登录数字工厂平台应用集成界面创建一个新应用，并获取到认证信息，请参考[获取认证信息]。 连接器验证，需要配置相关参数，参数说明请参考[表1]。 表1连接器认证参数说明 | 参数 | 类型 | 是否必填 | 说明 | 默认值 | 示例值 | |:---|:---|:---|:---|:---|:---| | 应用标识 | String | 是 | 注册应用后，分配的client_id。获取方法请参见[获取认证信息]。 | 无 | YVMBE\*\*\*QIJCR | | 应用密钥 | String | 是 | 注册应用后，分配的client_secret。获取方法请参见[获取认证信息]。 | 无 | \*\*\*\*\*\* | | 实例ID | String | 是 | 实例ID。获取方法请参见[获取对接信息]。 | 无 | aaa\*\*\*bbb | | 站点编码 | String | 否 | 站点编码。企业层调用时必填，行业层调用时不需要填写。获取方法请参见[获取对接信息]。 | 无 | DefaultSite | #### 创建模型实例数据 应用服务器可调用此接口创建数字工厂平台的模型实例数据。 - 输入参数 用户配置该执行动作，需要配置相关参数，参数说明请参考[表2]。 表2创建模型实例数据输入参数说明 | 参数 | 类型 | 是否必填 | 说明 | 默认值 | 示例值 | |:---|:---|:---|:---|:---|:---| | project_id | String | 是 | 项目ID。获取方法请参见[获取对接信息]。 | 无 | abc\*\*\*fffff | | model_id | String | 是 | 模型ID。获取方法请参见[获取模型ID]。 | 无 | abc\*\*\*fffff | | record | Object | 是 | 模型动态信息数据，JSON格式。 | 无 | { "id": "id1", "name": "name1", "status": "enabled" } | | parent_record_id | String | 否 | 上级模型实例数据唯一标识，创建子模型实例数据时必填。获取方法请参见[获取模型ID]。 | 无 | xxx | - 输出参数 用户可以在之后的执行动作中调用该输出参数，参数说明请参考[表3]。 表3创建模型实例数据输出参数说明 | 参数 | 类型 | 说明 | 默认值 | 示例值 | |:---|:---|:---|:---|:---| | record_id | String | 模型实例数据ID。 | 无 | aaabxxsax | | record | Object | 模型实例数据结构体，JSON格式。 | 无 | { "id": "id1", "name": "name1", "status": "enabled" } | #### 查询模型实例数据列表 应用服务器可调用此接口查询数字工厂平台的模型实例数据列表，了解模型实例数据的概要信息。 - 输入参数 用户配置该执行动作，需要配置相关参数，参数说明请参考[表4]。 表4查询模型实例数据列表输入参数说明 | 参数 | 类型 | 是否必填 | 说明 | 默认值 | 示例值 | |:---|:---|:---|:---|:---|:---| | project_id | String | 是 | 项目ID。获取方法请参见[获取对接信息]。 | 无 | abc\*\*\*fffff | | model_id | String | 是 | 模型ID。获取方法请参见[获取模型ID]。 | 无 | abc\*\*\*fffff | | limit | Integer | 否 | 分页查询时每页显示的记录数。取值范围：1\~50的整数。 | 10 | 50 | | marker | String | 否 | 上一次分页查询结果中最后一条记录的ID。 | ffffffffffffffffffffffff | ffffffffffffffffffffffff | | parent_record_id | String | 否 | 上级模型实例数据唯一标识，查询子模型实例数据时必填。 | 无 | aaabxxsax | | condition_type | String | 否 | 查询条件类型，所有条件（AND）、任意条件（OR）。 | 无 | OR | | conditions | Array | 否 | 查询条件。 | 无 | \[ { "code":"id", "op":"equal", "value": "abceddddddd" } \] | - 输出参数 用户可以在之后的执行动作中调用该输出参数，参数说明请参考[表5]。 表5查询模型实例数据列表输出参数说明 | 参数 | 类型 | 说明 | 默认值 | 示例值 | |:---|:---|:---|:---|:---| | records | Array | 模型实例数据列表。 | 无 | aaabxxsax | | page | Object | 列表分页信息。 | 无 | { "id": "id1", "name": "name1", "status": "enabled" } | #### 查询模型实例数据 应用服务器可调用此接口查询数字工厂平台指定模型实例数据详情信息。 - 输入参数 用户配置该执行动作，需要配置相关参数，参数说明请参考[表6]。 表6查询模型实例数据输入参数说明 | 参数 | 类型 | 是否必填 | 说明 | 默认值 | 示例值 | |:---|:---|:---|:---|:---|:---| | project_id | String | 是 | 项目ID。获取方法请参见[获取对接信息]。 | 无 | abc\*\*\*fffff | | model_id | String | 是 | 模型ID。获取方法请参见[获取模型ID]。 | 无 | abc\*\*\*fffff | | record_id | String | 是 | 模型实例数据ID，用于唯一标识一个模型实例数据。 | 无 | abc\*\*\*fffff | - 输出参数 用户可以在之后的执行动作中调用该输出参数，参数说明请参考[表7]。 表7查询模型实例数据输出参数说明 | 参数 | 类型 | 说明 | 默认值 | 示例值 | |:---|:---|:---|:---|:---| | record_id | String | 模型实例数据ID。 | 无 | aaabxxsax | | record | Object | 模型实例数据结构体，JSON格式。 | 无 | { "id": "id1", "name": "name1", "status": "enabled" } | #### 修改模型实例数据 应用服务器可调用此接口修改数字工厂平台的指定模型实例数据。 - 输入参数 用户配置该执行动作，需要配置相关参数，参数说明请参考[表8]。 表8修改模型实例数据输入参数说明 | 参数 | 类型 | 是否必填 | 说明 | 默认值 | 示例值 | |:---|:---|:---|:---|:---|:---| | project_id | String | 是 | 项目ID。获取方法请参见[获取对接信息]。 | 无 | abc\*\*\*fffff | | model_id | String | 是 | 模型ID。获取方法请参见[获取模型ID]。 | 无 | abc\*\*\*fffff | | record_id | String | 是 | 模型实例数据ID，用于唯一标识一个模型实例数据。 | 无 | abc\*\*\*fffff | | record | Object | 是 | 模型动态信息数据，JSON格式。 | 无 | { "id": "id1", "name": "name1", "status": "enabled" } | - 输出参数 无。 #### 删除模型实例数据 应用服务器可调用此接口删除数字工厂平台的指定模型实例数据。 - 输入参数 用户配置该执行动作，需要配置相关参数，参数说明请参考[表9]。 表9删除模型实例数据输入参数说明 | 参数 | 类型 | 是否必填 | 说明 | 默认值 | 示例值 | |:---|:---|:---|:---|:---|:---| | project_id | String | 是 | 项目ID。获取方法请参见[获取对接信息]。 | 无 | abc\*\*\*fffff | | model_id | String | 是 | 模型ID。获取方法请参见[获取模型ID]。 | 无 | abc\*\*\*fffff | | record_id | String | 是 | 模型实例数据ID，用于唯一标识一个模型实例数据。 | 无 | abc\*\*\*fffff | - 输出参数 无。 #### 获取对接信息 在调用接口时，URI以及请求体中需要填入项目ID、实例ID、站点编码。 从企业平台获取对接信息，包括接入地址（endpoint）、项目ID（project_id）、实例ID（X-Instance-Id）、站点编码（X-Site）。 1. 登录[华为云数字工厂企业平台](https://mp.iotstage.huaweicloud.com)。 2. 在左侧导航单击"系统 \> 接入信息"。 3. 在"接入信息"界面，获取接入信息，请参考[表10]。 表10接入信息说明 | 接入信息 | 使用说明 | |:---|:---| | 项目ID（project_id） | 对应API请求路径中的{project_id}参数。 | | 实例ID（instance_id） | 对应API请求头域中的X-Instance-Id参数。 | | 接入协议 | 对应请求URL的**URI-scheme**。例如，https:// | | 接入地址 | 对应请求URL的**Endpoint**。例如，https://127.0.0.1 | | 业务地址-站点编码 | 对应API请求头域中的X-Site参数。 | #### 获取模型ID 在调用接口时，API的请求参数需要填入模型ID。 1. 登录[华为云数字工厂企业平台](https://mp.iotstage.huaweicloud.com)。 2. 在左侧导航单击"建模 "，在"模型构建器"区域下，单击相应的模型卡片，进入模型详情界面。 这里以产品模型为例。其他模型同理。 3. 获取模型ID。 - 进入产品模型管理界面，单击需要获取的模型ID，如[图1]所示。 图1产品模型管理 ![](https://support.huaweicloud.com/usermanual-mssi/zh-cn_image_0000001798895813.png "点击放大") - 进入事务模型管理界面，单击需要获取的模型ID，如[图2]所示。 图2事务模型管理 ![](https://support.huaweicloud.com/usermanual-mssi/zh-cn_image_0000001799014845.png "点击放大") - 进入产品模型管理界面，查看子模型（结构模型、业务规则）的模型ID，如[图3]所示。 图3产品模型管理 ![](https://support.huaweicloud.com/usermanual-mssi/zh-cn_image_0000001751936154.png "点击放大") #### 获取认证信息 1. 登录[华为云数字工厂企业平台](https://mp.iotstage.huaweicloud.com)。 2. 在左侧导航单击"系统 \> 应用集成"。 3. 进入应用集成管理界面，单击"注册新应用"，填写应用信息。 4. 单击"确定"，应用创建成功后，会生成应用认证信息（client_id和client_secret），如[图4]所示。 ![](https://support.huaweicloud.com/usermanual-mssi/public_sys-resources/note_3.0-zh-cn.png) client_secret只会在创建时生成一次，后续不提供查询获取，一定要"点击复制"并在本地保存。 图4应用创建成功 ![](https://support.huaweicloud.com/usermanual-mssi/zh-cn_image_0000001752095054.png "点击放大") #### 重置认证信息 认证信息不提供密钥查询功能，数字工厂平台提供密钥重置能力，用于解决密钥遗忘问题，重置后原密钥和生产的Token会立即失效。 1. 登录[华为云数字工厂企业平台](https://mp.iotstage.huaweicloud.com)。 2. 在左侧导航单击"系统 \> 应用集成"。 3. 进入应用集成管理界面，在需要重置密钥的应用对应的"操作"列下，单击"重置密钥"。 4. 在弹出的"警告"界面，单击"确认"。 ![](https://support.huaweicloud.com/usermanual-mssi/public_sys-resources/note_3.0-zh-cn.png) 应用密钥重置成功后，会生成新的应用密钥信息。一定要"点击复制"并在本地保存。