配置示例
2. 开放API – 开放API
i. 创建API分组
每个API都归属到某一个API分组下，在创建API前应提前创建API分组。
ii. 绑定域名
在开放API前，您需要为API分组绑定一个独立域名，供用户访问API使 用。
在绑定独立域名前，您可以使用系统为API分配的默认子域名进行API调 用测试，ROMA Connect对默认子域名的访问次数做了限制，每天最多 可以访问1000次。
iii. 创建API
把已有后端服务封装为标准RESTful API，并对外开放。
iv. 调试API
通过ROMA Connect提供的调试功能，验证API服务的功能是否正常可 用。
v. 发布API
把API发布到环境中，API只有在发布到环境后，才支持被调用。
vi. 配置API授权（可选）
仅使用APP认证方式的API，才需要配置调用授权，把API授权给指定集 成应用，用户使用集成应用的Key和Secret进行API请求的安全认证。
– 创建并开放数据API
i. 接入数据源
接入数据源，确保可以正常从数据源读取数据。
ii. 创建数据API
把数据源定义为API，并对外开放。
iii. 配置API授权（可选）
仅使用APP认证方式的API，才需要配置调用授权，把API授权给指定集 成应用，用户使用集成应用的Key和Secret进行API请求的安全认证。
– 创建并开放函数API
i. 创建函数API
把自定义函数定义为API，并对外开放。
ii. 配置API授权（可选）
仅使用APP认证方式的API，才需要配置调用授权，把API授权给指定集 成应用，用户使用集成应用的Key和Secret进行API请求的安全认证。
3. 调用API
通过获取API及API访问地址，调用API。根据API使用认证方式的不同，调用API时 需要进行不同的认证鉴权操作。
5.2 开放 API
5.2.1 创建 API 分组
概述
API分组是同一类业务API的集合，API开发者以API分组为单位，管理分组内的所有 API。每个API都要归属到某个API分组下，在创建API前应提前创建API分组。
前提条件
每个API分组都要归属到某个集成应用下，在创建API分组前您需要有可用的集成应 用，否则请提前创建集成应用。
操作步骤
1. 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进 入实例控制台。
2. 在左侧的导航栏选择“服务集成 APIC > API管理”，在“API分组”页签中单击
“创建分组”。
3. 在创建分组弹窗中配置API分组相关信息，然后单击“确定”，创建API分组。
表5-1 API 分组配置
参数 配置说明
分组名称 填写API分组的名称，根据规划自定义。建议您按照一定的 命名规则填写API分组名称，方便您快速识别和查找。
类型 选择API分组的类型。
● 集成应用：API分组归属某个集成应用，仅拥有该集成应 用权限的用户可查看和操作该API分组。
● 全局：所有用户都可查看和操作该API分组。
集成应用 仅当“类型”选择“集成应用”时需要配置。
选择API分组所属的集成应用。若没有可用的集成应用，可 单击右侧的“新建集成应用”，创建一个集成应用。
描述 填写API分组的描述信息。
说明
● API分组创建后，系统为分组自动分配一个内部测试用的子域名，此子域名每天最多可 以访问1000次。
● Site实例不支持使用子域名调用API，仅支持使用IP+Host头方式调用API。
● 对外开放API时，您需要为API分组绑定您自己的独立域名。
5.2.2 绑定域名
概述
在开放API前，您需要为API分组绑定独立域名，用户通过独立域名访问分组内的API。
您也可以使用系统分配的默认子域名访问API分组内的API，该子域名唯一且不可修 改，每天最多可以访问1000次，仅适用于内部测试使用。
说明
Site实例不支持使用子域名调用API，仅支持使用IP+Host头方式调用API。
前提条件
● 已有独立域名。若还没有独立域名，您可以通过域名注册服务申请域名。
● 已完成独立域名的备案，您可以通过备案中心完成域名备案。备案时长需几个工 作日，建议您提前进行备案。
● 已完成独立域名到“服务集成APIC连接地址”的域名解析配置，具体请参考增加
A类型记录集。
● 如果API分组中的API支持HTTPS请求协议，则需要为独立域名添加SSL证书。您需 要提前获取SSL证书的内容和密钥，并创建SSL证书。
操作步骤
1. 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进 入实例控制台。
2. 在左侧的导航栏选择“服务集成 APIC > API管理”，在“API分组”页签中单击 API分组右侧的“更多 > 域名管理”。
3. 在域名管理页签下单击“绑定独立域名”。
4. 在绑定独立域名弹窗中填写要域名配置信息，完成后单击“确定”。
表5-2 独立域名配置
参数 配置说明
域名 填写要绑定的域名。
支持最小TLS版本 选择域名访问所使用的最小TLS版本。该配置仅对HTTPS生 效，不影响HTTP或者其他访问方式。
5. （可选）如果API分组中的API支持HTTPS请求协议，则需要为独立域名绑定SSL证 书。否则跳过此步骤。
a. 在已绑定的独立域名右侧单击“选择SSL证书”。
b. 在选择SSL证书弹窗中勾选要绑定的SSL证书，然后单击“确定”，完成SSL证 书的绑定。
若证书列表中无可用的SSL证书，可单击“创建SSL证书”，新增SSL证书，具 体操作配置请参考创建SSL证书。
5.2.3 创建负载通道（可选）
概述
ROMA Connect通过创建负载通道，可访问指定服务器中已部署的后端服务，并实现 后端服务访问的负载均衡功能。ROMA Connect可访问同一云服务平台上的弹性云服 务器（ECS），也可以访问用户自己的私有服务器。
例如，VPC中包含6台ECS，ROMA Connect已创建一条负载通道，并把ECS 01和ECS 04已添加到负载通道中，此时ROMA Connect通过负载通道可以直接访问VPC中的ECS 01和ECS 04。
图5-2 访问负载通道中的 ECS
前提条件
ROMA Connect与负载通道中的服务器之间的网络互通。
操作步骤
1. 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进 入实例控制台。
2. 在左侧的导航栏选择“服务集成 APIC > API管理”，在“负载通道”页签中单击
“创建负载通道”。
3. 在新建负载通道页面配置负载通道相关信息。
a. 配置负载通道基本信息。
表5-3 负载通道配置
参数 配置说明
通道名称 填写负载通道的名称，根据规划自定义。建议您按照 一定的命名规则填写负载通道名称，方便您快速识别 和查找。
端口 填写负载通道的服务器访问端口号。
分发算法 选择后端服务请求的分发算法，负载通道通过分发算 法确定请求被发送到哪台服务器上。
后端服务器类型 选择负载通道中的服务器成员类型。成员类型在负载 通道创建后将不能修改。
● 云服务器：通过选择云服务器的方式添加负载通道 成员。
● 服务器地址：通过填写服务器IP地址的方式添加负 载通道成员。
Site实例中，不支持添加实例类型的服务器成员。
b. 创建服务器分组
i. 单击“创建服务器分组”。
ii. 在创建服务器分组弹窗中配置分组信息，完成后单击“确定”。
您可以根据需要把服务器划分到多个分组中。
表5-4 服务器分组配置
参数 配置说明
分组名称 填写服务器分组的名称，根据规划自定义。建议您 按照一定的命名规则填写分组名称，方便您快速识 别和查找。
权重 填写服务器分组的权重值，权重值越大，转发到该 分组下服务器的请求数量越多。
描述 填写分组的描述信息。
c. 根据负载通道设置的“后端服务器类型”，添加云服务器或添加服务器地址 到负载通道。