检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
URL URL地址 请求协议:HTTP 后端服务地址:192.168.1.1:1234为•步骤四:后端开发部署后的后端服务地址或用户自己的后端服务地址。 自定义host头域 为简单起见,此处不配置。 后端超时 请求超时时间,此处填写“5000”ms。
IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括允许和禁止。 和“限制类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 单击“增加IP地址”,输入需要允许或者禁止访问API的IP地址,或IP地址范围。
常见问题 绑定域名失败常见原因 未将独立域名CNAME解析到服务的子域名上或域名重复。 添加SSL证书失败常见原因 生成证书的域名和实际添加证书所用的域名不一致。 父主题: API服务管理
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。
前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API测试”。 在当前应用关联的实例中,根据实际业务选择实例。
通道内服务器配置 服务器添加方式 选择添加服务器方式,目前支持“选择云服务器”和“指定服务器地址”。 单击“完成”,创建完成。 父主题: 实例管理
API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。 操作步骤。 登录ROMA API控制台。
校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。
校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。
允许:表示仅允许指定IP地址的客户端调用API。 禁止:表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”,添加允许或禁止调用API的客户端IP地址或IP地址段。 策略配置完成后,单击“确定”。 绑定API 登录ROMA API控制台。
1 RequestWrapper request = new RequestWrapper((HttpServletRequest) servletRequest); 使用正则表达式解析Authorization头,得到signingKey和signedHeaders。
单击“在线开发”,通过云端开发环境CloudIDE开发代码,请参考在线开发。 单击“克隆/下载”,克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域,单击“在线开发”。 通过IDE左侧的资源管理器可以看到后端代码的结构,如下所示。
白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。 单击“确定”,完成授权。 下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 选择需要下线的API。 单击“下线”,选择需要下线的环境。
32 proxy_protocol_addr 客户端源IP地址。 33 body_bytes_sent API请求的Body体大小,单位字节。 34 api_name API名称。 35 app_name 当使用APP认证访问时,请求方使用的APP名称。
API管理 包括API的创建、发布、下线和删除的完整生命周期管理,提供便捷的在线调试能力,支持导入Swagger文档一键生成API,以便更快速地开放API业务。 API策略 支持传统策略和插件策略。
Mock调测 对API设计文件的接口地址进行调测。 在页面中单击API设计文件名称,进入API编辑页面。 单击“编辑器”页签。 在编辑窗口上方开启“Mock”会自动生成Mock服务地址,您可以在可视化窗口对接口地址进行调测。
源IP流量限制 单个IP地址调用API次数上限。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个IP地址请求次数上限。 如果调用方在华为云弹性云服务器,且通过弹性公网IP访问API,则不能使用此限制策略。 描述 关于控制策略的描述。
后端服务地址(可选) 仅在不使用负载通道时,需要设置。 格式:“主机:端口”,主机为IP地址/域名,未指定端口时,HTTP协议默认使用80端口,HTTPS协议默认使用443端口。 端口范围:1 ~ 65535。
负载通道可允许后端直接访问ECS上面的实例地址。 URL URL地址由请求方法、请求协议、负载通道/后端服务地址和路径组成。 请求方法 GET、POST、DELETE、PUT、PATCH、HEAD、OPTIONS、ANY,其中ANY表示该API支持任意请求方法。