检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建环境 创建环境后,在创建API服务或发布API时,可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。
购买实例 创建应用前,需要先购买实例。实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。ROMA API提供了ROMA Connect实例和APIG实例。 ROMA Connect实例 ROMA Connect源自华为10年+数字化转型实践。聚焦应用
使用APP认证调用API 认证前准备 APP认证工作原理 Java Go Python C# JavaScript PHP C++ C Android curl
导出API服务 您可以把ROMA API上的API服务以YAML或JSON格式导出到本地,用于导入API服务或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。
调试API API创建后需要验证服务是否正常,控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题:
在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 在“环境变量”区域,单击“添加环境变量”。 每个用户最多创建10个环境。 单击“创建环境”,填写“环境名称”和“描述”。 单击“确定”,创建完成。 访问环境 通过RESTful API可以访
管理自定义认证 API自定义认证创建完成后,在自定义认证列表中显示新创建认证信息,同时也支持编辑、删除、更新等操作管理自定义认证。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。
创建SSL证书 如果API服务中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。 前提条件 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
管理SSL证书 SSL证书创建完成后,在证书列表中显示新创建证书信息,同时也支持编辑、删除操作管理证书。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。
由管理员管理您的访问密钥,方法请参见:管理IAM用户访问密钥。 请管理员为您配置权限或修改访问密钥保护状态。如需配置权限请参见:给IAM用户授权,如需修改访问密钥状态请参见:访问密钥保护。 管理员可以在“用户详情”页面查看IAM用户的访问密钥ID(AK),秘密访问密钥(SK)由IAM用户自行保管。 AK/SK生成步骤:
行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端,输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量,保存文件并退出编辑器。
您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。
时长 流量限制的时长,此处设置“4小时”。 API流量限制 单个API被调用次数上限100次。 用户流量限制 单个用户调用API次数上限,为简单起见,此处不配置。 应用流量限制 单个应用调用API次数上限,为简单起见,此处不配置。 源IP流量限制 单个IP地址调用API次数上限,为简单起见,此处不配置。
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A
选择Flask server “Target type”选择“Script path”,“Target”选择工程下的“backend_signature.py”文件,单击“OK”,完成工程配置。 校验后端签名示例 示例演示如何编写一个基于Flask的服务器,作为API的后端,并且实现一个
权限管理 ROMA API中管理员以及IAM用户创建的应用是隔离的,无法互相访问。如果用户想分配权限给不同的IAM用户,需要手动在应用管理内的权限管理进行分配,或在IAM中给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考:
基于HTTPS访问,保证网络传输安全;从数据入口屏蔽恶意调用,防重放、防篡改;从APP、API、IP等多维度设置的流控策略进行保护。 认证层 提供AK/SK、Token方式进行应用的认证,授权后才可访问;支持系统级和API级的IP黑白名单,拒绝恶意访问。 审计层 支持LTS日志分析,可为追查异常调用和恢复业务操作提供客观依据。
使用IAM认证调用API Token认证 AK/SK认证