检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
、灵活的实现API的跨域访问。 使用限制 已了解前提条件。 同一API服务下,相同请求路径的所有API,只能绑定同一个跨域资源共享策略。 若API开启了“支持CORS”功能的同时,也绑定了跨域资源共享策略,则以绑定的策略为准。 若某个请求路径下有OPTIONS方法的API,则该请
错误码 用户在调用API失败时,系统返回的错误码包含ROMA和APIG的错误码: 在ROMA实例下,系统返回的错误码请参考错误码。 在APIG实例下,系统返回的错误码请参考错误码。 父主题: 调用API
访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。 图2 运行环境信息 对于APP认证的API,您
认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。 后端:对后端服务的访问授权。 函数地址 选择用于前端自定义认证或后端自定义认证的函数后端,且创建的函数请求方法为“POST”。如需创建自定义后端,请参考创建用于前端认证的函数后端或创建用于后端认证的函数后端。
实现开发、测试、运行的并行操作,大大提升了产品的研发效率。 多重运行安全防护 API的开放无时无刻都在面临着巨大的安全攻击风险(DDoS、XSS、钓鱼、暴力攻击等),ROMA API提供了一套完善的4层防护架构,从接入层、认证层、审计层和转发层,层层保障您的后端安全。 接入层 基
API中管理员以及IAM用户创建的应用是隔离的,无法互相访问。如果用户想分配权限给不同的IAM用户,需要手动在应用管理内的权限管理进行分配,或在IAM中给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考:
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言
HTTP响应头管理 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统
不论“default(默认)”或是您自定义的网关响应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。 实现API的内部市场 ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中
单击“日志分析”页签,查看调用日志信息。 编辑实例 支持编辑实例的基本信息、参数、通道和环境。 找到需要编辑的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,然后单击可编辑对应参数信息。 单击“配置参数”页签,然后单击对应参数所在行的“编辑”,即可编辑参数信息。 单击“负载通
支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”,即可编辑应用信息。 删除应用 已创建的应用不再提供服务,可以将应用删除。 在搜索框中输入需要删除的应用名称。 单击对应应用所在行的“删除”,即可删除应用信息。 更新应用 刷新全局应用信息。
打开工程 打开Android Studio,选择“File > Open”。 在弹出的对话框中选择解压后的SDK路径。 打开工程后,目录结构如下。 图1 工程目录结构 调用API示例 在Android工程中的“app/libs”目录下,加入SDK所需jar包。其中jar包必须包括: java-sdk-core-x
域名,ROMA API对调试域名的访问次数做了限制,每天最多可以访问1000次。 独立域名:您自定义的域名,API调用者通过访问独立域名来调用您开放的API。 前提条件 已备案独立域名,未备案的独立域名无法被访问。 已经将独立的域名解析到该服务的实例IP上,具体方法请参考增加A类型记录集。
填写负载通道的名称,根据规划自定义。建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。 端口 填写负载通道的服务器访问端口号。 分发算法 选择后端服务请求的分发算法,负载通道通过分发算法确定请求被发送到哪台服务器上。 健康检查配置 协议 选择健康检查所使用的协议,可选
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题:
共享流控:针对绑定了该策略的所有API进行总流量统计和控制。 时长 流量限制的时长。 与“API流量限制”配合使用,表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示单位时间内的单个用户请求次数上限。 与“应用流量限制”配合使用,表示单位时间内的单个APP请求次数上限。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右下方的加号,然后单击“跨域资源共享”。 图1
提供如何在API的描述信息中使用markdown语法,使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore 提供多种复杂API的定义样例。 单击