检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 配置说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。 绑定凭据配额策略
请求参数的枚举值,请求参数的值只能从枚举值中选择,多个枚举值间用英文逗号隔开。 默认值 “必填”为“否”时,默认值生效。请求中不包含此参数时,ROMA API自动增加默认值发送给后端服务。 字节限制 最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
权限管理 ROMA API中管理员以及IAM用户创建的应用是隔离的,无法互相访问。如果用户想分配权限给不同的IAM用户,需要手动在应用管理内的权限管理进行分配,或在IAM中给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考:
API设计配置 ROMA API提供了API设计文件规范性检查,帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。 ROMA API也支持配置扩展字段,您按照Swagger规范性设计API的同时,也可额外自定义扩展字段。
创建自定义认证 自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的
API列表 API列表支持查看当前实例下所有的API,包含URL、运行环境、安全认证信息。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API列表”。 在当前应用关联的实例中,根据实
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access
购买实例 创建应用前,需要先购买实例。实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。ROMA API提供了ROMA Connect实例和APIG实例。 ROMA Connect实例 ROMA Connect源自华为10年+数字化转型实践。聚焦应用
JavaScript 操作场景 使用JavaScript语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 JavaScript SDK支持Node.js、浏览器等运行环境。 关于开发环境搭建,本章节以IntelliJ IDEA 2018
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。
基本概念 应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
管理API产品 API产品创建完成后,在产品列表中显示新创建API产品信息,同时也支持下架、下线等操作管理API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务,了解如何管理API产品。
配置参数 实例创建完成后,可在控制台编辑实例的配置信息。 前提条件 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。
流量控制 流量控制支持从用户、应用和时间段等不同的维度限制对API的调用次数,保护后端服务。支持按分/按秒粒度级别的流量控制。为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。 每个用户最多创建30个流控策略。 API添加流控策略相当于流控策略同步绑定了
调用已发布的API API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 获取API的请求消息 在调用API前,您需要向API管理者获取API的请求信息,包括访问域名、请求协议、请求方法、请求路径以及请求参数。 根据API使用
管理SSL证书 SSL证书创建完成后,在证书列表中显示新创建证书信息,同时也支持编辑、删除操作管理证书。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。
管理自定义认证 API自定义认证创建完成后,在自定义认证列表中显示新创建认证信息,同时也支持编辑、删除、更新等操作管理自定义认证。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。