检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A
选择已有策略:单击“选择已有策略”后,选择策略名称。 创建新策略:请参考表1所示输入信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“APP认证”、“Basic Auth”或“Public Key”。 在应用关联实例的配
可用区 选择实例所在的可用区,此处选择“可用区1”。 实例名称 填写实例的名称,根据规划自定义。建议您按照一定的命名规则填写实例名称,方便您快速识别和查找。 实例规格 选择实例的容量规格,实例创建后规格不可修改,此处选择“基础版”。 时间窗 选择技术支持对实例进行维护的时间段,建议选择
API服务提供了便捷式的API资产管理,通过规范化流程帮助企业快速实现资产变现。 丰富的API运营分析 支持详细的API调用分析和告警设置,识别系统可能存在的潜在风险,并借助离线日志分析,完成精细化的运营报表呈现,让您快速洞察API业务演进。
插件策略请参考下表配置: 表1 插件策略配置 参数 配置说明 策略名称 填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。
表1 SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称,根据规划自定义。建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件(后缀名为“.pem”),将证书内容复制到“证书内容”中即可。
负载通道参数说明 参数类型 参数项 说明 基本信息 通道名称 填写负载通道的名称,根据规划自定义。建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。 端口 填写负载通道的服务器访问端口号。 分发算法 选择后端服务请求的分发算法,负载通道通过分发算法确定请求被发送到哪台服务器上。
API的产品架构、功能和基础知识,有助于您快速准确的找到与实际业务匹配的功能。 产品介绍 什么是ROMA API 产品优势 应用场景 约束与限制 03 入门 如何实现一个完整的API全生命周期管理,您可以从初级使用者或中级使用者快速上手。 快速入门 初级使用者入门 中级使用者入门 05 实践 弹性云服务器(Elastic
配置凭据配额策略 参数 配置说明 策略名称 填写客户端配额策略的名称,根据规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。例如,时长为1小时,首次生效时间点为2020/08/08 05:05:00,则表示客户端配额策略从2020/08/08
根据下表参数信息,配置前端定义。 表1 前端定义参数 信息项 描述 API名称 API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法:GET、POST、DELETE、PUT、PATCH、HEAD
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务,了解如何管理API产品。 表1 管理产品 相关任务 使用场景 操作步骤 创建新版本 创建产品新版本,同步产品基本信息,可自行添加API。 单击需要创建新版本的产品名称。
提供简单GET请求样例。 DescriptionWithGFM 提供如何在API的描述信息中使用markdown语法,使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore
None 操作指导 ROMA API 如何创建API设计 02:50 创建API设计 ROMA API 如何创建API产品并上架 02:39 创建API产品 ROMA API 如何订阅API产品 02:40 订阅API产品 计算 云容器引擎 CCE 熟悉云容器引擎控制台 02:35
在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 根据下表相关任务,了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”,修改API信息,具体操作请参考创建API。
API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 根据下表相关任务,了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务,开放给其他用户使用。
已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务,了解如何管理实例。 表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。
API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 应用管理”。 根据下表相关任务,了解如何管理应用。 表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。
path”,“Target”选择工程下的“backend_signature.py”文件,单击“OK”,完成工程配置。 校验后端签名示例 示例演示如何编写一个基于Flask的服务器,作为API的后端,并且实现一个wrapper,对API网关(即API管理)的请求做签名校验。 API绑定签
的安全保护。 支持区域:华北-北京一、华北-北京四、华东-上海一、华南-广州 如何创建虚拟私有云? VPC服务介绍【视频】 VPC服务介绍【视频】 OBS 2.0支持API设计 主要介绍API设计者如何设计API文件。在API设计和变更阶段指导设计者遵从API格式规范,提升企业API的交付质量。
“ApigatewaySignatureFilter.java”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考校验后端签名示例。 校验后端签名示例 示例演示如何编写一个基于Spring boot的服务器,作为API的后端,并且实现一个Filter,对API网关(即API管理)的请求做签名校验。 A