检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API测试 通过导入API生成测试用例,快速实现API测试覆盖。 使用场景 API上线后,测试API连通性,以及通过定时测试任务来保障API稳定且长效运行。 前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
HTTP响应头管理策略 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA
研发,并实现开发、测试、运行的并行操作,大大提升了产品的研发效率。 多重运行安全防护 API的开放无时无刻都在面临着巨大的安全攻击风险(DDoS、XSS、钓鱼、暴力攻击等),ROMA API提供了一套完善的4层防护架构,从接入层、认证层、审计层和转发层,层层保障您的后端安全。 接入层
什么是ROMA API ROMA API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。
Synchronous:同步调用。指后端函数服务收到调用请求后立即执行并返回调用结果,客户端发送请求后同步等待,收到后端响应后关闭连接。 Asynchronous:异步调用。客户端不关注请求调用的结果,服务端收到请求后将请求排队,排队成功后请求就返回,服务端在空闲的情况下会逐个处理排队的请求。 后端超时 请求超时时间,1
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
户拥有“Tenant Administrator”权限)能设置。 凭据管理 2 HTTP响应头管理 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3
应用的Key和Secret(或客户端的AppKey和AppSecret),以及用于调用API的SDK。 简易认证:向API管理者获取该API所在应用的AppCode。 其他认证:向API管理者获取该API所授权应用的Key和Secret(或客户端的AppKey和AppSecret)或凭证信息。
约束与限制 约束限制 功能模块 限制条件 API设计 无 API实现 应用需关联CodeArts项目 API管理(除API测试) 应用需关联APIG实例/ROMA Connect实例 API测试 应用需关联CodeArts项目 API消费 无 API分析 应用需关联APIG实例/ROMA
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关(即API管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到H
API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右上方的加号,然后单击“访问控制”。 图1 单击访问控制 配置访问控制。 选择已有策略:单击“选择已有策略”后,选择策略名称。 创建新策略:请参考表1所示输入信息。
JavaScript 操作场景 使用JavaScript语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 JavaScript SDK支持Node.js、浏览器等运行环境。 关于开发环境搭建,本章节以IntelliJ IDEA 2018
总览 ROMA API是API全生命周期治理经验的产品,如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 图1 API全生命周期
“apikey”参数,携带的Key(或客户端的AppKey)进行API的调用认证。 app_basic app_basic认证方式开关。启用后,可在API请求中添加“Authorization”参数,携带的Key和Secret(或客户端的AppKey和AppSecret)进行API的调用认证。
凭据配额用于限制凭据在某个时间周期内的API调用次数,支持自定义重置时间。 绑定访问控制策略 客户端访问控制可控制访问API的客户端IP地址,保护后端服务。您可以为客户端设置访问控制策略,允许/禁止某个IP地址的客户端访问API。 绑定API 在当前凭据下绑定API,绑定后的API拥有当前凭据下的所有策略。
修改。 发送API请求时,需要将当前时间置于请求消息头的X-Sdk-Date,将签名信息置于请求消息头的Authorization。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 ROMA API除了校验时间格式外,还会校验该时间值与ROMA
API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右下方的加号,然后单击“跨域资源共享”。 图1 单击跨域资源共享 配置跨域访问控制。 选择已有策略:单击“选择已有策略”后,选择策略名称。
最多可以绑定5个独立域名,同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系,将已有的独立域名绑定到API服务上。当客户端发送请求时,根据HTTP请求中的域名定位到所属的API服务,再通过HTTPMethod和PATH确定唯一的API。 在绑定域名前,您需要了解以下2个概念:
为简单起见,此处不配置。 单击“完成”。 单击“确定”,将服务发布到“RELEASE”,页面自动跳转到“API运行”页面。 步骤六:配置策略 在“API运行”客户端右上方单击,选择“流量控制”。 配置流量控制策略。 图6 配置流量控制策略 表5 配置流量控制策略 参数 配置说明 配置方式 支持选择已有策