检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API管理 API服务管理 APIs管理 API列表 策略管理 自定义认证 SSL证书管理 API测试 凭据管理
带宽等网络特性。用户可以通过VPC方便地管理、配置内部网络,进行安全、快捷的网络变更。同时,用户可以自定义安全组内与组间弹性云服务器的访问规则,加强弹性云服务器的安全保护。 支持区域:华北-北京一、华北-北京四、华东-上海一、华南-广州 如何创建虚拟私有云? VPC服务介绍【视频】
表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓 设置后端代码保存的代码仓库名称,请不要跟该项目下已有代码仓库重名。 新建流水线 选择使用的流水线,当前仅支持在官方提供的流水线中选择。当前提供
绑定域名 您需要为API服务绑定一个或多个独立域名,每个API服务最多可以绑定5个独立域名,同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系,将已有的独立域名绑定到API服务上。当客户端发送请求时,根据HTTP请求中的域名定位到所属的API服务,再通过HTTP
单个IP地址调用API次数上限。 不超过“API流量限制”。 与“时长”配合使用,表示单位时间内的单个IP地址请求次数上限。 如果调用方在华为云弹性云服务器,且通过弹性公网IP访问API,则不能使用此限制策略。 描述 关于控制策略的描述。 单击“确定”,完成流量控制策略的创建。 父主题: APIs管理
SSL证书管理 创建SSL证书 管理SSL证书 父主题: API管理
仅在“限制类型”为“IP地址”时,需要设置。 说明: 允许或禁止访问的IP地址条数,分别可以配置最多100条。 账号名 输入需要允许或者禁止访问API的IAM账号名。IAM账号名的获取方式参考获取账号名。 仅在“限制类型”为“账号名”时,需要设置。支持输入多个账户名,以英文“,”隔开,如aaa
e等。 在搜索框中输入需要查看的应用名称。 单击应用名称,进入应用详情页面,查看应用ID、实例状态、集成应用、项目ID等。 权限管理 通过设置权限管理,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 具体操作请参考应用授权。 编辑应用 支持编辑或修改应用名称和描述。
凭据策略用于API运行时的策略管理,支持配置APPCode、绑定应用配额策略和绑定访问控制策略,且只有管理员(IAM用户拥有“Tenant Administrator”权限)能设置。 凭据管理 2 HTTP响应头管理 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义H
的能力。 HTTP响应头管理策略:可以自定义HTTP响应头,在返回的API响应中指定配置的响应头。 可见范围 当实例为ROMA类型时,支持设置当前应用可见或全局应用可见。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。 根据不同的策略类型,策略内容的配置不同:
生成产品 ROMA API支持把API服务中的API资源作为一个产品,共享给其他用户使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
调试API API创建后需要验证服务是否正常,控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
管理API设计 您可以在创建的API设计文件内,创建多个API,对API进行Tag分类,或者以YAML或JSON格式导出到本地,用于导入API设计或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。
什么是ROMA API ROMA API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
API测试 通过导入API生成测试用例,快速实现API测试覆盖。 使用场景 API上线后,测试API连通性,以及通过定时测试任务来保障API稳定且长效运行。 前提条件 对应实例已绑定弹性IP地址。 已开通测试计划。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA