检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在页面上单击服务名称,进入API服务详情页面。 在“网关响应”区域,即可新增或编辑网关响应。 如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 不论“default(默认)”或是您自定义的网关响应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。
API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则,检测API文件。 导入到API服务 5
保存”。 单击“创建后端”,选择导入文件类型。 导入API设计文件,从“API设计”中选择设计文件导入,单击“确定”。 导入Swagger文件,从本地导入文件,单击“打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目 自动读取当
单击凭据名称,进入策略详情页面。 在“AppCode”区域,单击“添加AppCode”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 配置说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。
查看API产品下的API详情。 选择API所属产品,单击产品名称。 在“版本列表”中选择版本。 选择API,单击“查看API”,查看监控视图、前端配置和后端配置等信息。 移除 API产品不需要某个API时,可将API从未上架产品中移除,即解除API与产品的绑定关系。 选择API所属产品,单击产品名称。
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
无问题修复,请单击“继续导入”。 选择步骤一中实例,填写服务名称,并选择API接口。 单击“全局配置(可选)”,定义API服务。 图5 全局配置 安全配置:选择认证方式,此处选择“APP认证”。 后端请求配置。 表4 后端请求参数配置 参数 配置说明 后端服务类型 选择后端服务类型,此处选择“HTTP&HTTPS”。
黑名单中的地址不允许调用API。 单击“确定”,完成授权。 下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 选择需要下线的API。 单击“下线”,选择需要下线的环境。 单击“确定”,完成下线。 删除API API不再提供服务且已下线,可以将API删除。
试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。 操作步骤。 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费
在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添加到一个API产品,无法同时添加到多个产品中。 完成产品的配置后,单击“立即创建”,创建API产品。 父主题: API服务管理
创建环境 创建环境后,在创建API服务或发布API时,可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。
P响应头,在返回的API响应中指定配置的响应头。 可见范围 当实例为ROMA类型时,支持设置当前应用可见或全局应用可见。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 根据不同的策略类型,策略内容的配置不同: 跨域资源共享策略 HTTP响应头管理策略
在“应用管理”中找到2中应用,单击该应用后的“权限管理”进行授权配置。 主账号可以对所有IAM用户创建的应用进行授权配置,IAM用户只能对自己创建的应用进行授权配置。 在弹窗中“用户列表”处勾选要授权的IAM用户,在“已选择”处为已选择的IAM用户配置应用的使用权限。 可为每个用户单独配置权限,也可以单击“权限”右侧的为所有已选择IAM用户批量配置权限。
无认证:无需认证信息。 调用API 配置请求地址相关参数。 API调用场景 API请求参数配置 使用域名调用API ROMA API允许使用服务分配的子域名或服务绑定的域名调用API,无需另外配置。 使用IP调用API ROMA API的实例配置参数“app_route”已设置为“on”,允许通过IP访问API。
应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。每个策
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。 API 默认导出API服务在
致来校验API请求是否合法。 同一个环境中一个API只能添加一个签名密钥,一个签名密钥可以添加到多个API上。 前提条件 API已发布。 配置签名密钥 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 >
(可选)配置SLA。单击。 需要配置SLA的API所在行,单击“配置SLA”。 勾选需要配置SLA的API,单击“批量配置SLA”。 (可选)Mock调测。 开启“Mock”会自动生成Mock服务地址,您可以在可视化窗口对接口地址进行调测。 (可选)规范性检查。 在规范性检查之前,您需提前启用规则集或创建
操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签,查看参数信息。 单击“负载通道”页签,查看通道信息。