检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
致来校验API请求是否合法。 同一个环境中一个API只能添加一个签名密钥,一个签名密钥可以添加到多个API上。 前提条件 API已发布。 配置签名密钥 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 >
填写服务名称,或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API,单击“立即导入”。 (可选)单击“全局配置(可选)”。 安全配置。 表1 安全配置参数说明 参数 参数说明 安全认证 API使用的认证方式,推荐使用APP认证。 APP认证:表示由ROMA API进行API请求的安全认证。
在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。 表1 独立域名配置 信息项 描述 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。
不允许绑定跨域资源共享策略。 为API绑定策略时,API的请求方法必须为allow_methods中允许的请求方法。 配置参数说明 表1 配置参数说明 参数 配置说明 allowed origins Access-Control-Allow-Origin响应头,指定允许访问API
(可选)配置SLA。单击。 需要配置SLA的API所在行,单击“配置SLA”。 勾选需要配置SLA的API,单击“批量配置SLA”。 (可选)Mock调测。 开启“Mock”会自动生成Mock服务地址,您可以在可视化窗口对接口地址进行调测。 (可选)规范性检查。 在规范性检查之前,您需提前启用规则集或创建
API设计 创建API设计 API设计配置 管理API设计
操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签,查看参数信息。 单击“负载通道”页签,查看通道信息。
实例管理 购买实例 管理实例 配置参数 创建负载通道 创建环境 分析日志 父主题: 管理中心
作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE,如
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费
需要拥有更高的性能跟全栈的应用集成能力 APIG实例: 需要实现API的开放托管,安全等配置 使用一些基础的API编排集成能力 前提条件 ROMA Connect实例: 有可用的VPC,并且已配置好子网与安全组,否则请参考准备资源完成VPC、子网和安全组的创建。 ROMA Conn
在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右上方的加号,然后单击“访问控制”。 图1 单击访问控制 配置访问控制。 选择已有策略:单击“选择已有策略”后,选择策略名称。 创建新策略:请参考表1所示输入信息。 表1 访问控制策略信息 信息项 描述
设计文件,单击“确定”。 导入Swagger文件:从用户本地导入API,生成测试用例。选择API文件,单击“打开”。 配置用例参数。 表1 用例参数 参数 配置说明 用例名称 用例的名称,根据规划自定义。 生成用例 生成用例方式分两种: 所有接口生成一个用例:将选择的API接口生成一个用例。
查看API产品下的API详情。 选择API所属产品,单击产品名称。 在“版本列表”中选择版本。 选择API,单击“查看API”,查看监控视图、前端配置和后端配置等信息。 移除 API产品不需要某个API时,可将API从未上架产品中移除,即解除API与产品的绑定关系。 选择API所属产品,单击产品名称。
在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 选择待调试的API,配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。
单击“创建API产品”。 根据参数提示,填写产品基本信息。 在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添加到一个API产品,无法同时添加到多个产品中。 单击“立即创建”,创建API产品。
在“编辑器”页面,单击“导入到API服务”,规则检查通过后,继续导入。 在“导入API设计文件”页面,选择实例并编辑服务名称。 进入“全局配置(可选)”页面,并发布。 将API服务生成产品。 在“API运行”页面,单击“生成产品”。 将API产品上架API目录。 进入产品详情页面,提交上架申请。
在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右上方的加号,然后单击“流量控制”。 图1 单击流量控制 配置流量控制。 选择已有策略:单击“选择已有策略”后,选择策略。 创建新策略:请参考表1所示输入信息。 表1 流控策略信息 信息项 描述 策略名称
导入到API服务”。 导入规则检测通过后,单击“继续导入”。 选择实例,编辑服务名称,选择API接口,单击“立即导入”。 (可选)服务全局配置具体操作步骤请参考导入API设计文件。 重命名 修改API设计文件名称。 单击对应API设计文件所在行的“重命名”,即可修改名称。 删除 删除API设计文件。
API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。 单击“配置访问日志”。 在弹窗中将“启动日志记录”修改为即启用日志记录能力。 “日志组”和“日志流”设置完成后,单击“确定”。 查看日志分析可单击“