华为云用户手册

功能简介 消息集成MQS是ROMA Connect的消息集成组件，使用统一的消息接入机制，提供跨网络访问的安全、标准化消息通道。使用ROMA Connect进行消息集成，有如下优势： 支持原生Kafka特性 兼容社区版Kafka的API，具备原生Kafka的所有消息处理特性。 支持安全的消息传输 独有的安全加固体系，提供业务操作云端审计，消息传输加密等有效安全措施。通过SASL认证，安全组等加强网络访问控制。 支持消息数据高可靠 支持消息持久化，多副本存储机制。副本间消息同步、异步复制，数据同步或异步落盘多种方式供您自由选择。

使用流程 使用ROMA Connect进行消息集成的流程如下图所示。 图1 业务使用流程 已创建实例和集成应用。 创建Topic 创建用于存储消息的Topic，供消息生产方发布消息和供消息消费方订阅消息。 配置Topic授权（可选） 若ROMA Connect实例开启了MQS的SASL_SSL，客户端向Topic发布和订阅消息时，需要使用授权集成应用的Key和Secret进行安全认证。 连接Topic 在系统中集成开源的Kafka客户端，然后通过客户端提供的命令行向Topic生产和消费消息。

操作步骤 登录ROMA Connect控制台，在左侧的导航栏选择“资产管理”。 在资产管理页面的“连接器”页签下，单击连接器上的“发布”。 在发布连接器弹窗中配置相关发布参数，完成后单击“确定” 表1 连接器配置 参数 配置说明 连接器实例名称 填写连接器实例的名称，根据规划自定义。建议您按照一定的命名规则填写连接器实例名称，方便您快速识别和查找。 连接地址 已部署连接器的访问地址。 认证方式 选择访问连接器实例所使用的安全认证方式，为简单起见，此处选择“无”。 无：不对接入请求进行认证。 AppKey：使用AppKey和AppSecret进行接入认证。 AppKey 填写用于连接器接入认证的AppKey，自定义。 AppSecret 填写用于连接器接入认证的AppSecret，自定义。 仅“编辑”状态的连接器可编辑，“发布”状态的连接器无法进行编辑。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“Redis”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 连接地址 填写Redis的连接地址和端口号。如果有多个连接地址，可单击“添加地址”添加。 如果Redis数据源为集群版Redis，需要把全部节点地址都写上。如果只写一个节点地址，ROMA Connect会认为是单机版Redis，会导致访问集群版Redis失败。 密码 填写Redis的连接密码。 数据库编号 填写Redis的数据库编号，不填写则默认连接编号0的数据库。 Redis数据源的接入配置示例如下图所示。 图1 Redis数据源配置示例 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“LDAP”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 URL 填写服务器的IP地址和端口，格式为：ldap://ip:port。 ip为数据库的访问地址。 port为数据库的访问端口。 安全认证类型 数据库的安全认证类型，目前仅支持“Simple”。 用户名 数据库的登录用户名。 密码 数据库的登录密码。 数据源的接入配置示例如下图所示。 图1 LDAP数据源配置示例 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“HANA”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 连接模式 选择数据库的连接方式。 默认：使用系统默认方式连接数据库。 专业：使用JDBC方式连接数据库。 连接地址 仅当“连接模式”选择“默认”时需要配置。 填写数据库的连接IP地址和端口号。 数据库名 仅当“连接模式”选择“默认”时需要配置。 填写要接入的数据库名。 连接字符串 仅当“连接模式”选择“专业”时需要配置。 填写HANA数据库的JDBC格式连接串，例如：jdbc:sap://{hostname}:{port}?databaseName={dbname}。 {hostname}为数据库的连接地址。 {port}为数据库的连接端口号。 {dbname}为要接入的数据库名。 用户名 填写连接数据库的用户名。 密码 填写连接数据库的用户密码。 HANA数据源的接入配置与DB2的类似，配置示例可参考DB2数据源接入配置示例。 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“MongoDB”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 连接地址 填写MongoDB的连接地址和端口号，格式为：IP:PORT。 如果MongoDB有多个副本集，可单击“添加地址”填写多个连接地址。 用户名 填写连接数据库的用户名。 密码 填写连接数据库的用户密码。 认证源 填写用于接入认证的MongoDB数据库名，即使用MongoDB的哪个数据库对接入用户进行认证。不填写则默认使用当前要接入的数据库对用户进行认证。 数据库名 填写要接入的数据库名。 集群模式 要接入的MongoDB数据库是否为集群模式。 若接入的MongoDB数据库为集群模式，则选择“是”。 若接入的MongoDB数据库为副本集模式或单节点模式，则选择“否”。 副本集 仅当“集群模式”选择“否”时需要配置。 若接入的MongoDB数据库为副本集模式，则填写副本集名称。 以接入单节点模式的MongoDB为例，该MongoDB数据源的接入配置示例如下图所示。 其中，认证源为“admin”，即使用MongoDB的admin数据库对连接用户root进行认证，认证通过后即可接入MongoDB的doctest数据库。 图1 MongoDB数据源配置示例 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“SNMP”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 连接地址 填写SNMP的连接IP地址和端口号。 网络协议 选择SNMP所使用的网络协议，可选择“UDP”和“TCP”。 版本号 选择SNMP的版本号。 0：表示SNMPv1 1：表示SNMPv2 3：表示SNMPv3 Community 仅当“版本号”选择“0”或“1”时需要配置。 填写SNMP团体名，用于访问SNMP管理代理的身份认证，相当于访问密码。 安全用户名 仅当“版本号”选择“3”时需要配置。 填写连接SNMP使用的安全名称。 上下文名称 仅当“版本号”选择“3”时需要配置。 填写SNMP中要访问的上下文名称。 安全等级 仅当“版本号”选择“3”时需要配置。 选择SNMP使用的安全等级。 1：表示无认证无加密 2：表示有认证无加密 3：表示有认证有加密 认证协议 仅当“安全等级”选择“2”或“3”时需要配置。 选择连接SNMP所使用的认证协议，可选择“MD5”和“SHA1”。 认证秘钥 仅当“安全等级”选择“2”或“3”时需要配置。 填写连接SNMP的认证密钥。 加密协议 仅当“安全等级”选择“3”时需要配置。 选择连接SNMP所使用的加密协议，可选择“DES”和“TRIDES”。 加密秘钥 仅当“安全等级”选择“3”时需要配置。 填写连接SNMP的加密密钥。 以接入SNMPv3为例，该SNMP数据源的接入配置示例如下图所示。 图1 SNMP数据源配置示例 单击“创建”，完成数据源的接入。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“ GaussDB (for MySQL)”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 连接模式 选择数据库的连接方式。 默认：使用系统默认方式连接数据库。 专业：使用JDBC方式连接数据库。 连接地址 仅当“连接模式”选择“默认”时需要配置。 填写数据库的连接IP地址和端口号。 连接字符串 仅当“连接模式”选择“专业”时需要配置。 填写数据库的JDBC格式连接串，例如：jdbc:mysql://{hostname}:{port}/{dbname}?characterEncoding=utf8&useSSL=true。 {hostname}为数据库的连接地址。 {port}为数据库的连接端口号。 {dbname}为要接入的数据库名。 数据库名 仅当“连接模式”选择“默认”时需要配置。 填写要接入的数据库名。 编码格式 仅当“连接模式”选择“默认”时需要配置。 填写数据库所使用的编码格式。 用户名 填写连接数据库的用户名。 密码 填写连接数据库的用户密码。 数据源的接入配置示例如下所示。 默认方式的数据库连接配置示例： 图1 默认方式配置示例 专业方式的数据库连接配置示例： 图2 专业方式配置示例 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

配置任务完成后执行 在创建任务页面中配置任务完成后执行信息。 表1 任务完成后执行 参数 配置说明 执行动作 选择任务完成后是否发送消息。 不发送消息：表示任务完成后不发送 消息通知 。 发送消息至Kafka：表示任务完成后发送消息至Kafka。 发送消息至 MRS Kafka：表示任务完成后发送消息至MRS Kafka。 FDI任务：FDI任务结束后，支持同时自动手工调度最多五个其它普通定时任务。 应用 选择对应的集成应用。 数据源 根据“执行动作”选择的数据源类型，选择相同类型数据源。 例如执行动作选择的是“发送消息至Kafka”，此处数据源则选择“Kafka”。 Topic 名称 选择用户接收消息的Topic。 自定义消息内容 可以通过${}来引用变量，自定义发送消息的内容。支持的变量如下： taskName：任务名称。 dataCount： 数据量。 targetTable：目标表。 dataSize：数据大小。 例如，内容${taskName}，表示只发送任务名称。 FDI任务 当“执行动作”选择“FDI任务”时需要配置。 选择需要执行的下一个FDI任务。如当前任务执行完成而选择的FDI任务如果处于运行中，跳过本次调度。 完成配置后，单击“保存”，完成数据集成任务的配置。

概述 本节主要提供数据集成任务异常数据存储的配置说明，仅当目标端数据类型为DB2、DWS、MySQL、GaussDB(for MySQL)、Oracle、PostgreSQL和SQL Server、Gauss100时可配置。 在每次任务执行过程中，如果源端的某些数据符合集成条件，但因为网络抖动或数据转换异常等原因，无法顺利集成到目标端数据源，则ROMA Connect可以将这些数据以文本文件的形式存储在OBS中。

配置异常数据存储 在配置异常数据存储前，您需要提前完成OBS数据源的接入配置，具体请参见接入OBS数据源。 在创建任务页面中配置异常数据存储信息。 表1 异常数据存储信息 参数 配置说明 集成应用 选择OBS数据源所属的集成应用。 源端数据类型 当前仅支持选择“OBS”。 数据源名称 选择已配置的OBS数据源。 Path 填写异常数据要存储到OBS数据源的对象名。Path的值不能以斜杠（/）结尾。 配置完成后，若需要配置任务完成后执行，请前往配置任务完成后执行（可选）；否则可直接单击“保存”，完成数据集成任务的配置。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“WebSocket”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 地址 填写WebSocket的连接URL地址。 ws（WebSocket）代表明文连接，使用明文连接时，URL地址格式为“ws://example.com”或“IP:PORT”形式。 wss（WebSocket Secure）代表加密连接，使用加密连接时，URL地址格式为“wss://example.com”或“IP:PORT”形式。 认证方式 选择连接WebSocket使用的认证方式。 None：表示无需认证授权，任何人都可以访问WebSocket。 Basic Auth：表示基础认证，需要输入用户名和密码进行认证。认证通过后，允许用户访问WebSocket。 用户名 仅当“认证方式”选择“Basic Auth”时需要配置。 填写连接WebSocket的用户名。 密码 仅当“认证方式”选择“Basic Auth”时需要配置。 填写连接WebSocket的用户密码。 以认证方式Basic Auth为例，数据源的接入配置示例如下图所示。 图1 WebSocket数据源配置示例 完成数据源接入配置后，单击“开始检测”，检测FDI与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“FTP”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 协议 选择接入FTP数据源使用的协议，可选择“FTP”和“SFTP”。 连接地址 填写FTP数据源的连接地址和端口号。 用户名 FTP数据源的登录用户名。 密码 FTP数据源的登录密码。 连接模式 仅当“协议”选择“FTP”时需要配置。 选择FTP数据源的连接模式。 主动模式：FTP服务器主动连接客户端的数据端口。 被动模式：FTP服务器被动等待客户端连接自己的数据端口。 数据源的接入配置示例如下图所示。 图1 FTP数据源配置示例 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

前提条件 导入产品前，请确保产品所属的集成应用已创建，否则请提前创建集成应用。 导入产品前，请检查导入产品的实例中是否存在重名产品，若存在重名产品，会导致导入产品失败。 导入产品前，请确保产品的配额满足需求。 导入文件格式为csv，并需要使用UTF-8 BOM编码。 在使用导出的文件导入产品时： 如果要新增产品，则需要另外新建导入文件，并在新建的文件中添加新的产品信息。 产品导入文件中表头的名称和顺序固定不能更改，表头名称请参考产品导入文件说明。 确认导入文件是否从老版本实例中导出：打开导入文件，查看是否存在“Base64:”开头的字段值。如果没有“Base64:”开头的字段值，则说明是老版本实例导出的文件。 如果是老版本实例导出的文件，需要重命名文件，在文件名后添加“-none-base64-prefix”，例如原文件名为“import.csv”，则需要重命名为“import-none-base64-prefix.csv”。 若使用Excel工具编辑导入文件，在编辑完成后需要按如下操作保存。 在Excel中保存时，以另存的方式保存为“ CS V(逗号分隔)(*.csv)”类型文件。 使用文本编辑器打开1中保存的csv格式文件，并再次另存，另存时编码选择“带有 BOM 的 UTF-8”，保存后即得到最终的csv格式导入文件。

产品导入文件说明 产品的导入文件内容要求见表1。 表1 产品导入文件内容说明 列名 描述 取值要求 ProductName 产品名称。 必填，复杂度要求与页面创建相同。 ProductSerial 产品标识。 必填。 ManufacturerId 厂商ID。 必填，复杂度要求与页面创建相同。 ManufactureName 厂商名称。 必填，复杂度要求与页面创建相同。 Model 产品型号。 必填，复杂度要求与页面创建相同。 ProductType 产品类型。 必填，普通产品：0，网关产品：1。 ProtocolType 协议类型。 必填，取值MQTT、MODBUS或OPCUA。 Username 用户名。 选填。 Password 密码。 选填。 appName 应用名称。 必填，应用名称已存在。 DeviceType 设备类型。 必填，默认为Default。 DataFormat 数据格式。 必填，默认为JSON。 Services 物模型。 选填，建议通过页面创建。

准备工作 在进行集成资产的恢复或迁移前，您需要做如下准备： 准备集成资产包。 获取用于导入的集成资产包。 获取资产包所属源实例的配置信息，仅资产迁移场景需要。 主要包括实例的安全组配置、实例配置参数和数据字典信息。 获取周边系统的对接信息，仅资产迁移场景需要。 系统 数据项 用途 数据源 数据源的访问IP、用户名和密码。 用于ROMA Connect对接数据源。 业务应用 业务应用的网段信息。 用于打通ROMA Connect到业务应用的网络。 父主题： 恢复/迁移集成资产

后续操作 如果系统表结构发生了变化或者有表级别调整，则需要重新开启CDC配置，配置步骤如下： 先关闭CDC配置，请根据实际情况填写schema和name。 EXEC sys.sp_cdc_disable_table @source_schema = N'dbo', @source_name = 'baris', @capture_instance ='all' 重新开启CDC配置，请根据实际情况填写schema和name。 开启表级别配置。 IF EXISTS(SELECT 1 FROM sys.tables WHERE name='baris' AND is_tracked_by_cdc = 0) BEGIN EXEC sys.sp_cdc_enable_table @source_schema = 'dbo', -- source_schema @source_name = 'baris', -- table_name @capture_instance = NULL, -- capture_instance @supports_net_changes = 1, -- supports_net_changes @role_name = NULL -- role_name END

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“Gauss100”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 连接模式 选择连接数据库模式。 默认：由系统根据用户配置自动拼接数据源连接字符串。 专业：由用户自己输入数据源连接字符串。 版本号 选择连接的版本号，支持V100R003C20和V300R001C00。 连接地址 仅当“连接模式”选择“默认”时需要配置。 填写数据库的连接IP地址和端口号。 数据库名 仅当“连接模式”选择“默认”时需要配置。 填写要接入的数据库名。 连接字符串 仅当“连接模式”选择“专业”时需要配置。 填写Gauss100数据库的JDBC格式连接串，格式：jdbc:postgresql://host:port/dbname。 host为数据库的连接地址。 port为数据库的连接端口号。 dbname为要接入的Gauss100数据库名。 用户名 数据库的登录用户名。 密码 数据库的登录密码。 Gauss100数据源的接入配置与DB2类似，配置示例可参考DB2数据源接入配置示例。 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

操作步骤 在实例控制台的“实例信息”页面选择“数据字典”页签。 单击“创建字典”。 在创建字典弹窗中配置数据字典相关信息，完成后单击“确认”。 表1 数据字典配置 参数 配置说明 字典编码 填写字典类唯一标识。 字典名称 填写字典类名称。 扩展字段1 作为字典类默认值，预留字段，可不填。 扩展字段2 描述 填写数据字典的描述信息。 数据字典创建完成后，单击字典名称前的“”展开字典项列表。 单击“创建字典项”。 在创建字典项弹窗中配置字典项相关信息，完成后单击“确认”。 表2 字典项配置 参数 配置说明 项编码 填写字典项唯一标识。 项名称 填写字典项名称。 扩展字段1 作为字典项默认值，预留字段，可不填。 扩展字段2 描述 填写字典项的描述信息。

配置参数说明 表1 配置参数 参数 配置说明 allow origin Access-Control-Allow-Origin响应头，指定允许访问API的外域URI，多个URI之间使用英文逗号隔开。 对于未携带身份凭证的请求，可以把参数值设置为“*”，表示允许来自所有域的访问请求。 allow methods Access-Control-Allow-Methods响应头，指定允许使用的HTTP请求方法，多个请求方法之间使用英文逗号隔开。 allow headers Access-Control-Allow-Headers响应头，指定XMLHttpRequest请求中允许携带的请求头字段，多个请求头之间使用英文逗号隔开。 其中，简单请求头Accept、Accept-Language、Content-Language、Content-Type（取值仅限为application/x-www-form-urlencoded、multipart/form-data、text/plain时）默认允许在请求中携带，无需在该参数中设置。 expose headers Access-Control-Expose-Headers响应头，指定XMLHttpRequest请求响应中允许携带的响应头字段，多个响应头之间使用英文逗号隔开。 其中，基本响应头Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma默认允许在响应中携带，无需在该参数中设置。 max age Access-Control-Max-Age响应头，指定本次预检请求的有效期，单位为秒。在有效期内，无需再次发出预检请求。 allow credentials Access-Control-Allow-Credentials响应头，定XMLHttpRequest请求中是否允许携带Cookie。 true表示允许。 false表示不允许。

脚本配置示例 { "allow_origin": "*", "allow_methods": "GET,POST,PUT", "allow_headers": "Accept-Ranges,Cache-Control", "expose_headers": "X-Request-Id,X-Apig-Latency", "max_age": 172800, "allow_credentials": true}

使用限制 同一API分组下，发布在同一环境且请求路径相同的所有API，只能绑定同一个跨域资源共享插件。 若API开启了“支持CORS”功能的同时，也绑定了跨域资源共享插件，则以绑定的插件为准。 若某个请求路径下有OPTIONS方法的API，则在OPTIONS方法API所在发布环境中，该请求路径的所有API均不允许绑定跨域资源共享插件。 为API绑定插件时，API的请求方法必须为allow_methods中允许的请求方法。

获取 域名 云服务平台内业务系统访问API的场景，需获取内网域名作为独立域名。 申请内网域名，具体请参考创建内网域名。 配置域名到“服务集成APIC 连接地址”的A类型记录集配置，具体请参考增加A类型记录集。 如果API分组中的API支持HTTPS请求协议，则需要为独立域名添加SSL证书。您需要提前获取SSL证书的内容和密钥，并创建SSL证书。 云服务平台外业务系统访问API的场景，需获取公网域名作为独立域名。 申请公网域名，具体可通过 域名注册服务 申请。 备案公网域名，您可以通过备案中心完成域名备案。备案时长需几个工作日，建议您提前进行备案。 配置域名到API分组子域名的CNAME类型记录集配置，具体请参考增加CNAME类型记录集。 如果API分组中的API支持HTTPS请求协议，则需要为独立域名添加SSL证书。您需要提前获取SSL证书的内容和密钥，并创建SSL证书。

配置参数说明 表1 配置参数 参数 配置说明 Name 响应头名称。每个插件中不能添加重复名称的响应头（不区分大小写）。 Value 响应头的值。当“Action”为“Delete”时响应头的值不生效，可为空。 Action 响应头操作，您可以覆盖、添加、删除、跳过或新增指定的响应头。 Override：覆盖 当API响应中存在指定的响应头时，使用当前响应头的值覆盖已有响应头的值。 当API响应中存在多个与指定响应头相同名称的响应头时，只会按当前响应头的值返回一条响应头记录。 当API响应中不存在指定的响应头时，添加当前响应头。 Append：添加 当API响应中存在指定的响应头时，将当前响应头的值添加到已有响应头的值之后，值之间用“,”分隔。 当API响应中存在多个与指定响应头相同名称的响应头时，会将多个响应头的值用“,”拼接后，再添加当前响应头的值。 当API响应中不存在指定的响应头时，添加当前响应头。 Delete：删除 当API响应中存在指定的响应头时，删除当前响应头。 当API响应中存在多个与指定响应头相同名称的响应头时，删除所有相同名称的响应头。 Skip：跳过 当API响应中存在指定的响应头时，跳过当前响应头。 当API响应中存在多个与指定响应头相同名称的响应头时，均不作处理直接返回。 当API响应中不存在指定的响应头时，添加当前响应头。 Add：新增 无论API响应中是否存在指定的响应头，都添加当前响应头。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 修改安全组配置，仅资产迁移场景需要，否则跳过此步。 在“实例信息”页面的“基本信息”页签下，单击安全组的名称。 在安全组配置页面中，根据准备工作中获取的源实例安全组信息和新实例的实际组网需求，修改安全组的规则配置。 ROMA Connect实例的安全组规则要求请参见表2。 修改实例路由信息，仅资产迁移场景需要，否则跳过此步。 在“实例信息”页面的“基本信息”页签下，更改路由信息。 修改实例配置参数，仅资产迁移场景需要，否则跳过此步。 在“实例信息”页面的“配置参数”页签下，根据准备工作中获取的源实例配置参数信息，修改配置参数。 添加数据字典配置。 在“实例信息”页面的“数据字典”页签下，根据准备工作中获取的源实例数据字典信息，添加数据字典配置。 具体创建字典的操作请参见创建数据字典。

业务场景 ROMA Connect支持把实例的应用和任务以资产文件形式导出，也可以把资产文件导入ROMA Connect，实现集成资产的快速恢复或迁移，资产文件的导入导出操作请参见导入导出资产。 资产恢复：从ROMA Connect实例导出集成资产进行数据备份，若后续因实例故障或数据丢失需要恢复资产数据，可将备份的资产文件再导入实例进行资产恢复。 建议定期导出资产文件进行数据备份（如按月导出资产文件），以供数据恢复使用。 资产迁移：把其他ROMA Connect实例导出的集成资产文件导入新建的实例，实现集成资产的快速部署和使用。 ROMA Connect的资产导入功能仅支持集成资产数据导入，不支持资产相关的实例配置数据导入。在完成集成资产的导入后，还需要完成资产相关的实例配置。 表1 实例配置 分类 数据项 说明 处理方式 实例公共 集成应用的Secret 集成应用的Secret为非资产数据。 资产导入后系统自动生成新的Secret，需要通知业务应用更新Secret。 集成应用的授权信息 集成应用的用户授权信息为非资产数据。 资产导入后重新配置用户授权。 数据集成 数据源的连接信息 数据源的连接信息包括地址、账号和密码，为非资产数据。 资产导入后重新为对应数据源配置连接信息。 服务集成 未发布RELEASE环境的API 未发布RELEASE环境的API包括未发布的API和发布在非RELEASE环境的API，为非资产数据。 资产导入后根据需要重新创建和发布API。 API的环境类信息 API的环境类信息包括独立域名、环境变量、负载通道的云服务器信息、非默认的环境，为非资产数据。 资产导入后需重新配置环境类信息。 API的控制策略信息 API的控制策略信息包括流量控制策略、访问控制策略、客户端访问控制策略和客户端配额策略，为非资产数据。 资产导入后重新配置控制策略信息。 API的密钥类信息 API的密钥类信息包括签名密钥、客户端的AppCode、自定义后端的密码和证书类型配置值，为非资产数据。 资产导入后： 系统自动为签名密钥生成新的Key和Secret，需要通知后端服务更新Key和Secret。 重新配置客户端的AppCode。 重新为自定义后端配置项配置密码和证书的值。 API授权的黑白名单 API授权的黑白名单信息为非资产数据。 资产导入后重新配置黑白名单信息。 设备集成 设备信息 设备信息非资产数据。 资产导入后重新创建设备信息。 设备的规则信息 设备的规则信息非资产数据。 资产导入后重新创建设备的规则信息。

业务流程 集成资产的恢复/迁移流程如下表所示。 表2 业务流程 序号 操作 说明 1 准备工作 获取集成资产包，并收集周边系统（如数据源、后端服务、业务应用）的对接信息。 2 修改实例配置 修改待恢复或新实例的安全组、配置参数等配置。 3 导入集成资产 在待恢复或新实例中导入集成资产包。 4 修改集成应用配置 修改集成应用的授权配置。 5 修改数据源配置 修改数据源的连接配置。 6 修改API配置 修改API的环境、控制策略、密钥、黑白名单等配置。 7 修改设备配置 批量创建设备和规则。 8 业务对接适配和验证 周边业务系统的对接适配和业务验证。

配置参数说明 ROMA Connect的实例配置参数如下表所示。 表2 配置参数说明 参数名 参数说明 ratelimit_api_limits API全局默认流控值。API未绑定流控策略时，执行此默认流控；API绑定流控策略时，则执行绑定的流控策略。 request_body_size API请求中允许携带的Body大小上限。 backend_timeout APIC到后端服务的请求超时时间上限。 app_token app_token认证方式开关。启用后，可在API请求中使用获取的access_token进行API的调用认证。 app_token_expire_time：access_token的有效时间，在access_token到期前，需要获取新的access_token。 refresh_token_expire_time：refresh_token的有效时间。refresh_token用于获取新的access_token。 app_token_uri：获取access_token的uri。 app_token_key：access_token的加密key。 app_api_key app_api_key认证方式开关。启用后，可在API请求中添加“apikey”参数，携带集成应用的Key（或客户端的AppKey）进行API的调用认证。 app_basic app_basic认证方式开关。启用后，可在API请求中添加“Authorization”参数，携带集成应用的Key和Secret（或客户端的AppKey和AppSecret）进行API的调用认证。 app_jwt app_jwt认证方式开关。启用后，可在API请求中添加“Authorization”和“Timestamp”参数，携带集成应用的Key和Secret（或客户端的AppKey和AppSecret）以及时间戳进行API的调用认证。 app_jwt_auth_header：app_jwt认证头，即API请求中携带app_jwt认证信息的Header参数，默认为Authorization。 app_secret app_secret认证方式开关。启用后，可在API请求中添加“X-HW-ID”和“X-HW-AppKey”参数，携带集成应用的Key和Secret（或客户端的AppKey和AppSecret）进行API的调用认证。 public_key public_key类型后端签名开关。启用后，可在后端签名认证中使用public_key类型签名。 public_key_uri_prefix：获取public_key对应secret的uri前缀。具体uri格式为：https://{服务集成APIC 连接地址}{public_key_uri_prefix}{public_key签名密钥名称}。 app_route 支持IP访问开关。启用后，非DEFAULT分组下的API可以使用IP地址调用。 使用app_router方式进行调用的API，其所属应用以及授权应用下不能有路径相同的API，如果有相同路径的API，在使用app_router前需要删除所有路径相同的API，并重新创建。 cascade API级联功能开关。启用后，可以实现跨实例间的API调用。 cascade_auth_key：级联认证的加密密钥，用于级联API之间的调用认证。 cascade_instance_ids：级联实例的实例ID列表，仅允许的实例可级联到当前实例。 default_group_hide DEFAULT分组隐藏开关。启用后，DEFAULT分组被隐藏。 livedata_config 自定义后端配置。 sandbox_max_memory：函数后端中执行脚本所允许使用的内存最大值。 sandbox_max_cpu_time：函数后端中执行脚本所允许占用的CPU时间最大值。 livedata_env：自定义后端的运行模式，设置为online时，自定义后端将会按照线上格式返回。 gw_address_protocol：函数脚本中，通过DICT:gw_rest_float_addr字段传递的默认请求协议。 procedure_async：存储过程是否使用异步方式执行。 dataapi_return_type：数据后端的返回格式。 backend_client_certificate 后端双向认证开关。启用后，创建API配置后端服务时，可配置后端双向认证。 ssl_ciphers 可支持配置的https加密套件，可根据需要选择开启的加密套件。 apiclient_first_use_x_hw_id 自定义后端的ApiClient类是否优先使用X-HW-ID字段进行校验。 real_ip_from_xff 是否使用X-Forwarded-For头中的IP作为ACL、流控的判断依据。 xff_index：X-Forwarded-For头中IP的排序序号，值允许为正数、负数、0。 xff_index值为0或正数时，获取X-Forwarded-For头中对应索引的IP。 xff_index值为负数时，按倒序方式从X-Forwarded-For头中获取IP。 例如到达API网关的X-Forwarded-For头中依次有IP1，IP2，IP3三个IP地址，xff_index取0时获取IP1，xff_index取1时获取IP2，xff_index取-1时获取IP3，xff_index取-2时获取IP2。 custom_log 自定义日志功能开关。开启自定义日志功能后，ROMA Connect实例下所有API的调用日志中会打印指定位置（header、query和cookie）和指定名称的参数值。 启用后，需单击“添加”，添加需在调用日志中打印的参数。 自定义日志只支持打印客户端发起的请求中携带的信息，不支持打印APIC中定义的常量参数和系统参数信息。 自定义日志最多支持添加10个参数，且所有参数字段总大小不超过2KB。 自定义日志打印的参数值中部分特殊字符会进行编码，例如：加号（+）会被编码为空格，双引号（"）会被编码为“\x22”，反斜杠（\）会被编码为“\x5C”。 real_ip_header_getter header_getter：是否开启用户自定义Header获取源ip地址，作为访问控制、流控策略的源ip生效依据。 vpc_name_modifiable 负载通道名称支持修改开关。开启后可修改负载通道名称，但当前实例的负载通道无法通过“VPC通道管理-项目级”API接口操作。 default_group_host_trustlist DEFAULT分组中的API是否支持非本实例IP访问。开启后，IP列表中配置的地址可访问DEFAULT分组中的API，请根据业务需要谨慎添加。 缺省分组是否支持配置非本实例IP：DEFAULT分组中的API是否支持非本实例IP访问开关。 非本实例IP列表：填写允许访问DEFAULT分组中API的非本实例主机地址，多个IP地址间使用英文分号（;）分隔。 data_api_column_types_converted_to_string 数据后端是否支持数据列类型转换String类型。开启后，勾选的数据列类型允许转换为String类型数据。 是否支持配置数据列类型：数据后端的数据列类型转换String类型开关。 数据列类型列表：勾选要转换String类型的数据列类型，当前仅支持nvarchar2类型。 kafka_log_plugin_options Kafka日志推送插件可推送的请求体和响应体大小配置。 request_body_size：Kafka日志推送插件可推送的请求体大小上限。 response_body_size：Kafka日志推送插件可推送的响应体大小上限。 sse_strategy SSE传输策略开关，默认关闭。启用后，支持通过使用Server-Sent Events (SSE)按照流式输出后端API的响应内容，可以实现逐字符渲染。 sse_strategy配置完成后，如需修改，至少需要1分钟后。 request_custom_config 支持自定义配置客户端请求相关参数。 HTTP/2：HTTP/2协议的开关，默认为开启状态。 request_body_timeout：客户端请求体超时时间的修改，默认为8秒。网络状况差或请求体过大的情况下可适当调整该参数。 客户端请求自定义配置修改完成后，如需再次修改，至少需要1分钟后。 gzip 对响应请求使用gzip压缩，用于减少公网流量。默认未配置gzip压缩，配置后1分钟生效，请谨慎修改。 启用后，可配置comp_level参数，comp_level表示压缩级别，值越大表示性能消耗越大，一般默认为6。 响应请求体大于1KB时，您可以使用gzip压缩文件（即1KB以下的文件不做压缩）。 gzip压缩支持的文件类型有text/xml、text/plain、text/css、application/javascript、application/x-javascript、application/rss+xml、text/javascript、image/tiff、image/svg+xml、application/json、application/xml 启用gzip压缩后，须在请求中添加请求头“Accept-Encoding: gzip”。 gzip配置完成后，如需修改，至少需要1分钟后。 custom_auth_header 认证头域自定义配置开关，默认关闭。启用后，参数“app_auth_header”和“backend_sign_header”的初始值为空，与不启用效果一致。 如果配置“app_auth_header”的“参数运行值”，那么对于APP认证的API，请求header中携带APP认证信息的参数为此处“app_auth_header”的值；如果配置“backend_sign_header”的“参数运行值”，那么对于绑定HMAC或者Basic Auth类型签名密钥策略的API，APIC到后端服务的请求header中携带签名信息的参数为此处“backend_sign_header”的值。 配置后会影响当前实例下所有APP认证或签名密钥策略（HMAC/Basic Auth类型），请谨慎配置。 api_uri_no_escape API的URL中的Path转义处理开关。默认关闭，表示URL中的Path会进行转义处理。 开启“api_uri_no_escape”开关后，使用Path不转义的功能请参见表3。 op_trusted_ips API认证方式为华为 IAM 认证时可配置。 控制 API 的调用来源 IP 。新建实例的“op_trusted_ips”默认禁止所有源IP访问，需要在“配置参数”页面的“op_trusted_ips”中添加源IP网段才可以访问。 访问控制策略中的IP地址控制属于API级别控制IP，此处的IP控制属于实例级别控制IP。 表3 Path不转义影响的功能 功能 描述 API前端定义的Path 请求发送时使用的Path api_uri_no_escape开关关闭 api_uri_no_escape开关开启 API定义 APIC进行匹配路由的Path /{path} /aa%2Faa /aa/aa /aa%2Faa 参数编排 后端服务参数使用的Path - - /aa/aa /aa%2Faa http到https重定向 重定向使用的Path - - /aa/aa /aa%2Faa 策略后端 策略条件为请求入参的Path - - /aa/aa /aa%2Faa 第三方认证策略 API绑定第三方认证策略后，传递到第三方的Path - - /aa/aa /aa%2Faa kafka日志推送策略 API绑定kafka日志推送策略后，使用的请求Path - - /aa/aa /aa%2Faa 负载通道 使用URI哈希分发算法的负载通道时，APIC用来转发的Path - - /aa/aa /aa%2Faa FunctionGraph后端 API的后端类型为FunctionGraph时，发送到函数请求Path - - /aa/aa /aa%2Faa 自定义认证 API认证方式选择自定义认证时，发送到函数请求Path - - /aa/aa /aa%2Faa

修改配置参数 在实例控制台的“实例信息”页面选择“配置参数”页签，可查看实例的配置参数，也可修改“参数运行值”。 表1 配置参数 内容 内容说明 参数 参数的名称。把光标移到参数名称前的“”，可查看参数的具体功能说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过，该更新时间为空。 操作 单击“编辑”，可修改“参数运行值”。