检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API服务 ROMA API提供了API服务能力,通过API服务把后端服务封装成标准RESTful格式API,并开放给其他用户使用。 目前支持三种创建服务方式: 创建API服务 创建一个简单的服务,不包含API,用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件,同步创建服务。
绑定域名 您需要为API服务绑定一个或多个独立域名,每个API服务最多可以绑定5个独立域名,同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系,将已有的独立域名绑定到API服务上。当客户端发送请求时,根据HTTP请求中的域名定位到所属的API服务,再通过HTTPMethod和PATH确定唯一的API。
backend-signature:后端服务签名示例,请根据实际情况修改参数后使用。具体代码说明请参考校验后端签名示例。 sdk-request:签名算法的调用示例。 校验后端签名示例 示例演示如何编写一个基于ASP.Net Core的服务器,作为API的后端,并且实现一个IAut
已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 已安装IDEA,如果未安装,请至IDEA官方网站下载。 已安装Java Development Kit 1.8.111或以上版本,如果未安装,请至Oracle官方下载页面下载。 获取SDK 下载SDK的最新版本,
规范化管理,帮助企业快速实现API经济,并持续构建高质量的API服务能力。 免费体验 图说ECS 立即使用 成长地图 由浅入深,带您玩转ROAM API 弹性云服务器一 弹性云服务器二 弹性云服务器三 弹性云服务器四 01 了解 了解ROMA API的产品架构、功能和基础知识,有
在控制台单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务,了解如何管理实例。 表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。
已获取apigateway-backend-signature-demo。 获取并安装IntelliJ IDEA,如果未安装,请至IntelliJ IDEA官方网站下载。 已安装Java Development Kit 1.8.111或以上版本,如果未安装,请至Oracle官方下载页面下载。 导入工程 打开IntelliJ
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
实例。 在页面上单击服务名称,进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与
在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右上方的加号,然后单击“访问控制”。 图1 单击访问控制 配置访问控制。 选择已有策略:单击“选择已有策略”后,选择策略名称。 创建新策略:请参考表1所示输入信息。 表1 访问控制策略信息
在“应用管理”中找到2中应用,单击该应用后的“权限管理”进行授权配置。 主账号可以对所有IAM用户创建的应用进行授权配置,IAM用户只能对自己创建的应用进行授权配置。 在弹窗中“用户列表”处勾选要授权的IAM用户,在“已选择”处为已选择的IAM用户配置应用的使用权限。 可为每个用户单独配置权限,也可以单击“权限”右侧的为所有已选择IAM用户批量配置权限。
应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。每个策
选择克隆版本,单击“克隆新版本”。 单击“确定”,克隆完成。 在已克隆版本中可查看、添加或移除API,以及上架克隆版本。 同步 API服务变更后,需要手动同步信息到产品。 选择变更API服务所属产品,单击产品名称。 在“版本列表”中选择同步版本。 在需要同步的API所在行,单击“同步”。 查看API 查看API产品下的API详情。
选择步骤一中实例,填写服务名称,并选择API接口。 单击“全局配置(可选)”,定义API服务。 图5 全局配置 安全配置:选择认证方式,此处选择“APP认证”。 后端请求配置。 表4 后端请求参数配置 参数 配置说明 后端服务类型 选择后端服务类型,此处选择“HTTP&HTTPS”。 负载通道 “不使用”负载通道。 URL
API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 根据下表相关任务,了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API
如果您无法管理您的访问密钥,请联系管理员: 由管理员管理您的访问密钥,方法请参见:管理IAM用户访问密钥。 请管理员为您配置权限或修改访问密钥保护状态。如需配置权限请参见:给IAM用户授权,如需修改访问密钥状态请参见:访问密钥保护。 管理员可以在“用户详情”页面查看IAM用户的访
创建环境 创建环境后,在创建API服务或发布API时,可以直接将API部署到环境上。 前提条件 已创建ROMA Connect实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。
APP认证方式调用API,需要提前获取如下信息: 访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。
API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 应用管理”。 根据下表相关任务,了解如何管理应用。 表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。