检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access
访问控制 访问控制策略是ROMA API提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以创建访问控制策略,允许/禁止某个IP地址或账号访问绑定策略的API。 每个用户最多可以创建100个访问控制策略。 API添加访问控制策略相当于访问控制策略同步绑定了
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
跨域资源共享 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。 前提条件 API已发布。 配置跨域访问控制 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
创建凭证 凭证代表用户认证标识,用户通过凭证来订阅上架的产品,订阅后方可调用对应产品下的API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。
Java 操作场景 使用Java语言进行后端服务签名时,您需要先获取SDK,然后导入工程,最后参考校验后端签名示例校验签名是否一致。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,
AK/SK认证 使用AK(Access Key ID)、SK(Secret Access Key)对请求进行签名。 AK:访问密钥ID。与私有访问密钥关联的唯一标识符,访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK:与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。
总览 ROMA API是API全生命周期治理经验的产品,如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 图1 API全生命周期
Android 操作场景 使用Android语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Android
创建应用 开始使用ROMA API前,您需要先创建应用,然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。
流量控制 流量控制支持从用户、应用和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。 每个用户最多创建30个流控策略。 API添加流控策略相当于流控策略同步绑定了
管理API产品 API产品创建完成后,在产品列表中显示新创建API产品信息,同时也支持下架、下线等操作管理API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务,了解如何管理API产品。
C# 操作场景 使用C#语言进行后端服务签名时,您需要先获取SDK,然后打开工程,最后参考校验后端签名示例校验签名是否一致。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥,并绑定API,具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Visual
创建API服务 ROMA API提供了API服务能力,通过API服务把后端服务封装成标准RESTful格式API,并开放给其他用户使用。 目前支持三种创建服务方式: 创建API服务 创建一个简单的服务,不包含API,用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件,同步创建服务。
Java 操作场景 使用Java语言调用APP认证的API时,您需要先获取SDK,然后导入示例代码,最后参考调用API示例调用API。 本章节以IDEA为例介绍。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 已