检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与
API概念,提供的能力,以及操作指引。 您可以根据不同角色查看行为路径,或者单击“查看指引”查看详细的操作指引。 初级使用者入门指导 中级使用者入门指导 高级使用者,敬请期待。 API治理专家,敬请期待。 目前仅初级使用者和中级使用者支持“查看指引”。
创建负载通道 创建负载通道后,在创建API服务,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的负载通道。 前提条件 已创建云服务器。如需创建请参考创建云服务器。 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 在“网关响应”区域,即可新增或编辑网关响应。 如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。
与“API流量限制”配合使用,表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示单位时间内的单个用户请求次数上限。 与“应用流量限制”配合使用,表示单位时间内的单个APP请求次数上限。 API流量限制 单个API被调用次数上限。 与“时长”配合使用,表示单位时间内的单个API请求次数上限。
在控制台单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务,了解如何管理实例。 表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。
通过设置权限管理,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 具体操作请参考应用授权。 编辑应用 支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”,即可编辑应用信息。 删除应用 已创建的应用不再提供服务,可以将应用删除。 在搜索框中输入需要删除的应用名称。
审核申请通过后,产品信息编辑成功。 删除 API产品不再提供服务,且产品已下架,可以将API产品删除。 在API产品所在行,单击“删除”。 确认删除产品信息后,单击“确定”。 不推荐 不推荐表示产品待下架。待下架的产品不推荐用户订阅,已订阅用户仍可继续使用,直到产品下架。 选择待下架的API产品,单击产品名称。
靠性和性能指标。 (可选)Mock调测,对接口地址进行调测。 (可选)规范性检查,对接口规范性检查。 (可选)导入到API服务,将已设计的接口导入API服务。 (可选)可视化设计API文件,对接口可视化设计。 (可选)配置SLA。单击。 需要配置SLA的API所在行,单击“配置SLA”。
API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference Java huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3
所示: 图1 后端开发流程图 创建后端 后端是一种以业务功能为主的服务设计概念,每一个后端都具有自主运行的业务功能。同时,后端支持框架代码的查看、删除,以及源码包的下载功能。 在线开发 后端创建完成后,您可以使用“在线开发”开发代码,通过CodeArts IDE Online修改
多个URI之间使用英文逗号隔开。 对于未携带身份凭证的请求,可以把参数值设置为“*”,表示允许来自所有域的访问请求。 allowed methods Access-Control-Allow-Methods响应头,指定允许使用的HTTP请求方法,多个请求方法之间使用英文逗号隔开。
击“启用”。 如需创建规则集,请参考创建规则集。 在弹窗中单击“确定”。 在已启用的规则集显示“当前使用”,规则集启用成功。 如需取消已启用的规则集,可启用另一个规则集,将当前使用规则集覆盖。 如需查看已启用规则,可单击规则集名称。 (可选)查看规则集详情,包含已启用规则和未启用规则,可单击“管理”或“查看”。
安全的API托管服务,帮助企业轻松构建、管理和部署不同规模的API。简单、快速、低成本、低风险的实现内部系统集成、成熟业务能力开放及业务能力变现。 使用场景 ROMA Connect实例: 需要解决跨网及多云API业务集成 需要使用丰富的API编排跟数据API服务能力 需要拥有更高的性能跟全栈的应用集成能力
的AppKey和AppSecret)进行API的调用认证。 使用app_secret认证时,需同时关闭app_api_key认证方式。 app_route 支持IP访问开关。启用后,非DEFAULT服务下的API可以使用IP地址调用。 backend_client_certificate
remote_addr 客户端地址 2 request_id 请求ID 3 api_id API ID 4 user_id 当使用IAM认证访问时,请求方提供的项目ID 5 app_id 当使用APP认证访问时,请求方提供的APP ID 6 time_local 请求时间 7 request_time
根据下表相关任务,了解如何管理策略。 表1 管理策略 相关任务 使用场景 操作步骤 编辑策略 修改策略信息。 选择需要编辑的策略,或单击策略名称,进入策略详情。 单击“编辑”,修改策略信息,具体操作请参考创建API策略。 删除策略 删除不再使用的策略。 单击策略名称,进入策略详情。 未绑定API的策略,单击右上角“删除”。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 选择待调试的API,配置API请求参数后,单击“调试”。
许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。 前提条件 API已发布。 配置跨域访问控制 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。