初级使用者入门指导

准备工作

• 已准备VPC、子网和安全组。
• 已在本地PC上下载并安装接口调试工具。

步骤一：购买实例

1. 选择实例类型。
   1. 登录ROMA API控制台，单击，选择区域。
   2. 在左侧导航栏选择“管理中心 > 实例管理”。
   3. 单击“购买实例”。
   4. 选择实例类型，以ROMA实例为例。
2. 购买ROMA实例。
   1. 创建ROMA实例。
      图2 配置实例信息
      

      表1 配置实例信息

      参数	配置说明
      计费模式	选择实例的计费模式，此处选择“免费试用”。
      区域	选择实例所在的区域，此处选择“华北-北京四”。
      可用区	选择实例所在的可用区，此处选择“可用区1”。
      CPU架构	选择“x86计算”。
      实例规格	选择实例的容量规格，实例创建后规格不可修改，此处选择“基础版”。
      增强功能	增强实例功能。
      企业项目	选择实例所属的企业项目，保持默认设置“default”。
      实例名称	填写实例的名称，根据规划自定义。建议您按照一定的命名规则填写实例名称，方便您快速识别和查找。
      描述	填写实例的描述信息。
      虚拟私有云	选择实例所关联的VPC和子网。
      安全组	选择实例所关联的安全组。
      公网访问	为简单起见，此处不开启。
      消息集成(MQS)设置
      Kafka版本	选择实例所使用的Kafka服务端版本号，此处选择“2.3.0”版本。
      消息集成(MQS)容量阈值策略	实例中MQS消息存储达到容量阈值时（存储空间的95%）的处理策略，此处选择“生产受限”。
      消息集成(MQS) SASL_SSL	消息传输的SASL认证和SSL加密，为简单起见，此处不开启。

   2. 单击“立即购买”。
   3. 勾选同意协议，单击“提交”。

步骤二：创建应用

1. 在左侧导航栏选择“总览”或“管理中心 > 应用管理”。
2. 单击“创建应用”。
3. 配置应用信息，关联步骤一中实例。
   图3 创建应用
   
4. 单击“创建”。
5. 应用创建完成后，在页面左上角“ROMA API”下切换已创建的应用。

步骤三：创建API服务

1. 在左侧导航栏选择“API管理 > API服务”。
2. 选择步骤一中实例。
3. 单击“创建API服务”，选择“导入Swagger文件”。
4. 在本地选择Swagger文件，单击“打开”。
5. 设置服务名称，选择接口。单击“立即导入”。
   图4 创建API服务
   
6. 在弹窗中，单击“确定”，将API服务发布到RELEASE环境，页面自动跳转到“API运行”页面。

步骤四：配置策略

1. 在“API运行”客户端右上方单击，选择“流量控制”。
2. 配置流量控制策略。
   图5 配置流量控制策略
   

   表2 配置流量控制策略

   参数	配置说明
   配置方式	支持选择已有策略或创建新策略，此处选择“创建新策略”。
   策略名称	API流控策略名称，建议您按照一定的命名规则填写策略名称，方便您快速识别和查找。
   类型	流控类型，此处选择“基础流控”，针对单个API进行流量统计和控制。
   时长	流量限制的时长，此处设置“4小时”。
   API流量限制	单个API被调用次数上限100次。
   用户流量限制	单个用户调用API次数上限，为简单起见，此处不配置。
   应用流量限制	单个应用调用API次数上限，为简单起见，此处不配置。
   源IP流量限制	单个IP地址调用API次数上限，为简单起见，此处不配置。
   描述	关于控制策略的描述。

3. 单击“确定”。

步骤五：调试API

1. 单击“调试”。
2. 填写请求参数，单击“调试”。
   在页面下方显示请求消息和响应结果，若调试成功，状态码显示“200”。

   图6 调试
   

步骤六：绑定域名

1. 单击“基本信息”页签。
2. 在“域名管理”区域，单击“绑定独立域名”。
3. 填写域名配置信息。

   表3 独立域名配置

   参数	配置说明
   域名	填写要绑定的域名。 绑定的域名需要您在域名服务商处购买，并配置解析到对应的实例。
   支持最小TLS版本	选择域名访问所使用的最小TLS版本，此处选择“TLS1.2”。

4. 单击“确定”。

步骤七：调用API

1. 获取API的请求信息。
   单击“API运行”页签，查看API接口请求方法、URL和请求参数。

   图7 获取API的请求信息
   
2. 调用API。

   使用接口测试工具调用1中获取的API请求信息。

   调用成功后，显示“200 OK”。