前提条件 确保业务系统所在网络与ROMA Connect的网络互通。 若通过公网互通，ROMA Connect实例需绑定弹性IP。 确保业务系统的数据库为ROMA Connect支持的数据源类型。 函数API支持的数据源请参见服务集成支持的数据源。 准备一个可用的独立 域名 ，用于作为API的访问域名。 确保已完成独立域名到“服务集成APIC连接地址”的域名解析配置，具体请参考配置公网域名解析。 若还没有独立域名，您可以通过 域名注册服务 申请域名，并通过备案中心完成域名备案。 如果函数API使用HTTPS请求协议，您还需要为独立域名申请SSL证书，并获取pem格式的SSL证书内容和密钥。

前提条件 确保业务系统所在网络与ROMA Connect的网络互通。 若通过公网互通，ROMA Connect实例需绑定弹性IP。 确保业务系统的数据库为ROMA Connect支持的数据源类型。 数据API支持的数据源请参见服务集成支持的数据源。 准备一个可用的独立域名，用于作为API的访问域名。 确保已完成独立域名到“服务集成APIC连接地址”的域名解析配置，具体请参考配置公网域名解析。 若还没有独立域名，您可以通过域名注册服务申请域名，并通过备案中心完成域名备案。 如果数据API使用HTTPS请求协议，您还需要为独立域名申请SSL证书，并获取pem格式的SSL证书内容和密钥。

在中台实例创建API 在中台实例创建并开放API，使用子公司实例中的API作为后端服务。各子公司或合作伙伴通过调用中台实例开放的API，实现对各子公司能力的调用。 创建API的过程请参考创建API，仅后端配置有如下区别。 表7 API后端服务配置 参数 配置说明 后端服务类型 选择后端服务的类型。使用子公司实例的API作为后端服务时，需选择“HTTP/HTTPS”。 负载通道 是否使用负载通道访问后端服务。使用子公司实例的API作为后端服务时，需选择“使用”。 URL 配置后端服务的URL。 请求方法：选择后端服务的请求方法，根据子公司实例中API的请求方法选择。 请求协议：选择后端服务使用的请求协议，根据子公司实例中API的请求协议选择。 负载通道：选择访问后端服务所使用的负载通道，选择配置级联实例间的负载通道所创建的负载通道。 路径：填写后端服务的请求路径，格式如：/getUserInfo/{userId}。请求路径中可包含Path参数，以{参数名}形式表示。 如果请求路径中需要携带环境变量，则使用“#变量名#”的形式将环境变量添加到请求路径中，如/#path#。环境变量名严格区分大小写，支持添加多个环境变量，如/#path##request#。 级联标识 是否使用级联方式访问后端服务，选择开启。 自定义host头域 自定义后端服务请求中的Host头域。若配置级联实例间的负载通道中创建负载通道时，“后端服务器地址”填写了IP地址，则此处需要填写子公司实例API的域名。 后端超时 (ms) 后端服务请求的超时时间，默认为5000ms。 重试次数 ROMA Connect调用后端服务失败后的重试次数。 值为-1时，表示不开启重试功能。 值为0-10时，表示开启重试功能，并根据设置的值执行重试。重试次数不能大于负载通道中已启用的后端服务器个数。 TLS双向认证 仅当“协议”选择“HTTPS”时可配置。 选择是否在ROMA Connect和后端服务间启用双向认证。使用子公司实例的API作为后端服务时，不启用双向认证。 后端认证 选择是否启用后端认证。使用子公司实例的API作为后端服务时，不启用后端认证。

配置实例间的级联关系 配置中台实例到各子公司实例的级联关系，使中台实例可使用各子公司实例的开放API作为后端服务。 在子公司实例配置级联功能。 登录子公司实例A所在的ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在“实例信息”页面选择“配置参数”页签，并找到级联功能开关参数“cascade”。 单击参数右侧的“编辑”，把参数运行值设置为“on”，然后单击“保存”，打开级联功能开关。 单击参数左侧的“”，展开并配置级联相关配置参数。 表1 子公司实例配置 参数 配置说明 cascade_auth_key 级联认证的加密密钥，用于级联API之间的调用认证。子公司实例和中台实例的cascade_auth_key值必须配置一致。 cascade_instance_ids 填写中台实例的实例ID。 重复1.a-1.d，配置在子公司B的ROMA Connect实例上配置级联功能。 在中台实例配置级联功能。 登录中台实例所在的ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在“实例信息”页面选择“配置参数”页签，并找到级联功能开关参数“cascade”。 单击参数右侧的“编辑”，把参数运行值设置为“on”，然后单击“保存”，打开级联功能开关。 单击参数左侧的“”，展开并配置级联相关配置参数。 表2 中台实例配置 参数 配置说明 cascade_auth_key 级联认证的加密密钥，用于级联API之间的调用认证。公司实例和中台实例的cascade_auth_key值必须配置一致。 cascade_instance_ids 中台实例中无需配置该参数。

概述 在开放API前，您需要为API分组绑定独立域名，用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种： 内网域名：部署在云服务平台内的业务系统，可以使用内网域名访问API。 公网域名：部署在云服务平台外的业务系统，可以使用公网域名访问API。 您也可以使用系统分配的默认子域名访问API分组内的API，该子域名唯一且不可修改，每天最多可以访问1000次，仅适用于内部测试使用。 Site实例不支持使用子域名调用API，仅支持使用IP+Host头方式调用API。

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

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

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

概述 在开放API前，您需要为API分组绑定独立域名，用户通过独立域名访问分组内的API。 独立域名可分为内网域名和公网域名两种： 内网域名：部署在云服务平台内的业务系统，可以使用内网域名访问API。 公网域名：部署在云服务平台外的业务系统，可以使用公网域名访问API。 您也可以使用系统分配的默认子域名访问API分组内的API，该子域名唯一且不可修改，每天最多可以访问1000次，仅适用于内部测试使用。 Site实例不支持使用子域名调用API，仅支持使用IP+Host头方式调用API。

准备依赖资源 ROMA Connect实例所需资源的具体要求和创建指导如下所示。 表1 ROMA Connect依赖资源 准备资源 要求 创建指导 VPC和子网 不同的ROMA Connect实例可以复用相同的VPC和子网，也可以使用不同的VPC和子网，请根据实际需要进行配置。在创建VPC和子网时应注意如下要求： 创建的VPC与使用的ROMA Connect服务应在相同的区域。 创建VPC和子网时，如无特殊需求，配置参数使用默认配置即可。 创建VPC和子网的操作指导请参考创建虚拟私有云和子网，若需要在已有VPC上创建和使用新的子网，请参考为虚拟私有云创建新的子网。 安全组 不同的ROMA Connect实例可以复用相同的安全组，也可以使用不同的安全组，请根据实际需要进行配置。在创建安全组时应注意如下要求： 创建安全组时，“模板”选择“自定义”。 安全组创建后，请保留系统默认添加的入方向和出方向规则。 使用ROMA Connect服务要求必须添加表2所示安全组规则，其他规则请根据实际需要添加。 创建安全组的操作指导请参考创建安全组，为安全组添加规则的操作指导请参考添加安全组规则。 （可选）弹性公网IP 若需要通过公网访问ROMA Connect，则需要申请弹性公网IP，否则不需要申请弹性公网IP。每个实例只需要绑定一个公网IP。 申请弹性公网IP的操作指导请参考申请弹性公网IP。 表2 安全组规则 方向 协议 端口 源地址 说明 入方向 TCP 80 0.0.0.0/0 通过公网访问APIC（无SSL加密）。 入方向 TCP 443 0.0.0.0/0 通过公网访问APIC（有SSL加密）。 入方向 TCP 1883 0.0.0.0/0 通过公网访问LINK（无SSL加密）。 入方向 TCP 7443 0.0.0.0/0 通过公网访问LINK（RESTful API方式）。 入方向 TCP 8443 0.0.0.0/0 通过公网访问LINK（有SSL加密）。 入方向 TCP 9092 0.0.0.0/0 通过内网访问MQS（无SASL认证）。 入方向 TCP 9093 0.0.0.0/0 通过内网访问MQS（有SASL认证）。 入方向 TCP 9094 0.0.0.0/0 通过公网访问MQS（无SASL认证）。 入方向 TCP 9095 0.0.0.0/0 通过公网访问MQS（有无SASL认证均使用）。 入方向 TCP 9096 0.0.0.0/0 通过公网访问MQS（有无SASL认证均使用）。 入方向 TCP 9097 0.0.0.0/0 通过公网访问MQS（有SASL认证）。 入方向 TCP 9292 0.0.0.0/0 通过公网访问MQS（RESTful API方式）。

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

前提条件 ROMA Connect与负载通道中服务器之间的网络互通。 若ROMA Connect实例与服务器在相同VPC内时，可直接访问服务器。 若ROMA Connect实例与服务器在同一区域的不同VPC内时，可通过创建VPC对等连接，将两个VPC的网络打通，实现同一区域跨VPC访问服务器。具体步骤请参考VPC对等连接说明。 若ROMA Connect实例与后端服务在不同区域的不同VPC内时，可通过创建云连接实例并加载需要互通的VPC，将两个VPC的网络打通，实现跨区域跨VPC访问服务器。具体步骤请参考跨区域VPC互通。 若ROMA Connect实例与服务器通过公网互通，请确保ROMA Connect实例已绑定弹性IP。 用户账号需要具备VPC Administrator角色权限。

LINK支持的监控指标 表4 LINK支持的监控指标 指标ID 指标名称 指标含义 取值范围 单位 进制 测量对象（维度） 监控周期（原始指标） online_connections 在线设备数 该指标用于统计用户在线设备的连接数。 ≥0 Count 不涉及 实例 1分钟 msg_count 消息总数 该指标用于统计用户所有设备发送的消息总数。 ≥0 Count 不涉及 实例 1分钟 msg_tps TPS 该指标用于统计时间区间内设备每秒发送消息数。 ≥0 Times/s 不涉及 实例 1分钟 msg_max_latency 发送消息最大时延 该指标用于统计时间区间内设备发送消息延迟毫秒数。 ≥0 ms 不涉及 实例 1分钟

维度 Key Value instance_id ROMA Connect实例 fdi 数据集成 apic 服务集成 kafka_instance_id 消息集成实例 kafka_broker 消息集成Broker节点 kafka_rest 消息集成Rest节点 kafka_topics 消息集成队列 kafka_partitions 消息集成分区 kafka_groups-partitions 消息集成分区的消费组 kafka_groups_topics 消息集成队列的消费组 kafka_groups 消息集成消费组 link 设备集成

MQS支持的监控指标 表3 MQS支持的监控指标 指标ID 指标名称 指标含义 取值范围 单位 进制 测量对象（维度） 监控周期（原始指标） current_partitions 分区数 统计实例中已经使用的分区数量。 ≥0 Count 不涉及 实例 1分钟 current_topics 主题数 统计实例中已经创建的主题数量。 ≥0 Count 不涉及 实例 1分钟 group_msgs 堆积消息数 统计实例中所有消费组中总堆积消息数。 ≥0 Count 不涉及 实例 1分钟 broker_data_size 节点数据容量 统计节点当前的消息数据大小。 ≥0 Byte/KB/MB/GB/TB/PB 1024(IEC) 节点 1分钟 broker_messages_in_rate 消息生产速率 统计每秒生产的消息数量。 ≥0 Count/s 不涉及 节点 1分钟 broker_bytes_out_rate 消费流量 统计每秒消费的字节数。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 节点 1分钟 broker_bytes_in_rate 生产流量 统计每秒生产的字节数。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 节点 1分钟 broker_public_bytes_in_rate 公网入流量 统计Broker节点每秒公网访问流入流量。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 节点 1分钟 broker_public_bytes_out_rate 公网出流量 统计Broker节点每秒公网访问流出流量。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 节点 1分钟 broker_fetch_mean 生产请求平均处理时长 统计Broker节点处理生产请求平均时长。 ≥0 ms 不涉及 节点 1分钟 broker_produce_mean 消费请求平均处理时长 统计Broker节点处理消费请求平均时长。 ≥0 ms 不涉及 节点 1分钟 broker_alive 节点存活状态 统计MQS节点是否存活。 ≥0 - 不涉及 节点 1分钟 broker_connections 连接数 统计MQS节点当前所有TCP连接数量。 ≥0 Count 不涉及 节点 1分钟 broker_cpu_usage CPU使用率 统计MQS节点虚拟机的CPU使用率。 ≥0 % 不涉及 节点 1分钟 broker_disk_read_await 磁盘平均读操作耗时 统计磁盘在测量周期内平均每个读IO的操作时长。 ≥0 ms 不涉及 节点 1分钟 broker_disk_write_await 磁盘平均写操作耗时 统计磁盘在测量周期内平均每个写IO的操作时长。 ≥0 ms 不涉及 节点 1分钟 broker_total_bytes_in_rate 网络入流量 统计MQS节点每秒网络访问流入流量。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 节点 1分钟 broker_total_bytes_out_rate 网络出流量 统计MQS节点每秒网络访问流出流量。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 节点 1分钟 broker_cpu_core_load CPU核均负载 统计MQS节点虚拟机CPU每个核的平均负载。 ≥0 - 不涉及 节点 1分钟 broker_disk_usage 磁盘容量使用率 统计MQS节点虚拟机的磁盘容量使用率。 ≥0 % 不涉及 节点 1分钟 broker_memory_usage 内存使用率 统计MQS节点虚拟机的内存使用率。 ≥0 % 不涉及 节点 1分钟 broker_heap_usage Kafka进程JVM堆内存使用率 统计MQS节点Kafka进程JVM中的堆内存使用率。 ≥0 % 不涉及 节点 1分钟 produced_messages 生产消息数 统计Rest节点每分钟生产消息数。 ≥0 Count 不涉及 节点 1分钟 topic_bytes_in_rate 生产流量 统计Rest每秒钟生产流量。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 节点 1分钟 topic_bytes_out_rate 消费流量 统计Rest每秒钟消费流量。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 节点 1分钟 topic_messages_in_rate 消息生产速率 统计每秒生产的消息数量。 ≥0 Count/s 不涉及 队列 1分钟 topic_bytes_out_rate 消费流量 统计每秒消费的字节数。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 队列 1分钟 topic_bytes_in_rate 生产流量 统计每秒生产的字节数。 ≥0 Byte/s、KB/s、MB/s、GB/s、TB/s、PB/s 1024(IEC) 队列 1分钟 topic_messages 队列消息总数 统计队列当前的消息总数。 ≥0 Count 不涉及 队列 1分钟 produced_messages 生产消息数 统计目前生产的消息总数。 ≥0 Count 不涉及 队列 1分钟 partition_messages 分区消息数 统计分区中当前的消息个数。 ≥0 Count 不涉及 队列 1分钟 messages_consumed 分区已消费消息数 统计当前消费组已经消费的消息个数。 ≥0 Count 不涉及 消费组 1分钟 messages_remained 分区可消费消息数 统计消费组可消费的消息个数。 ≥0 Count 不涉及 消费组 1分钟 topic_messages_remained 队列可消费消息数 统计消费组指定队列可以消费的消息个数。 ≥0 Count 不涉及 消费组 1分钟 topic_messages_consumed 队列已消费消息数 统计消费组指定队列当前已经消费的消息数。 ≥0 Count 不涉及 消费组 1分钟 consumer_messages_remained 消费组可消费消息数 统计消费组剩余可以消费的消息个数。 ≥0 Count 不涉及 消费组 1分钟 consumer_messages_consumed 消费组已消费消息数 统计消费组当前已经消费的消息数。 ≥0 Count 不涉及 消费组 1分钟