检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建应用 开始使用ROMA API前,您需要先创建应用,然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。
根据下表相关任务,了解如何管理应用。 表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。 在搜索框中输入需要查看的应用名称。 单击应用名称,进入应用详情页面,查看应用ID、实例状态、集成应用、项目ID等。
应用管理 创建应用 管理应用 父主题: 管理中心
通过开放业务能力,使自身服务能力变现,部门B直接订阅部门A开放的API,减少开发时间和成本,实现部门之间业务共享。 前提条件 已创建应用和实例。 开放API A部门将自己的业务变现。 将A部门的业务生成设计文档。 在“API设计”页面,选择“创建API设计 > 导入Swagger
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
使用APP认证调用API 认证前准备 APP认证工作原理 Java Go Python C# JavaScript PHP C++ C Android curl
c "+base64(appkey+":"+appsecret),其中appkey和appsecret分别为获取API的请求信息中获取到的Key和Secret(或AppKey和AppSecret)。 app_jwt认证 ROMA API的实例配置参数“app_jwt”已设置为“on”,开启app_jwt认证。
勾选同意协议,单击“提交”。 步骤二:创建应用 在左侧导航栏选择“总览”或“管理中心 > 应用管理”。 单击“创建应用”。 配置应用信息,关联步骤一中实例。 图3 创建应用 单击“创建”。 应用创建完成后,在页面左上角“ROMA API”下切换已创建的应用。 步骤三:创建API设计 在左侧导航栏单击“API设计”。
应用状态显示异常是什么原因? 应用的状态基于应用关联的资源状态来显示: 应用关联的ROMA/APIG实例状态异常,或者关联ROMA集成应用不存在时,应用资源会变成异常状态。 有一个应用资源状态显示异常,整个应用的状态就会显示异常。 修复或移除对应的异常资源,应用状态会恢复正常。
自定义认证的具体使用指导,可参考《 应用与数据集成平台 ROMA Connect 开发指南》的自定义认证相关章节。 前提条件 已在函数工作流服务中完成函数创建。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理
接入层 基于HTTPS访问,保证网络传输安全;从数据入口屏蔽恶意调用,防重放、防篡改;从APP、API、IP等多维度设置的流控策略进行保护。 认证层 提供AK/SK、Token方式进行应用的认证,授权后才可访问;支持系统级和API级的IP黑白名单,拒绝恶意访问。 审计层 支持L
基本概念 应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
购买实例 创建应用前,需要先购买实例。实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。ROMA API提供了ROMA Connect实例和APIG实例。 ROMA Connect实例 ROMA Connect源自华为10年+数字化转型实践。聚焦应用和数据联
在“API接口”列表中勾选要开放的API,单击“立即导入”。 (可选)单击“全局配置(可选)”。 安全配置。 表1 安全配置参数说明 参数 参数说明 安全认证 API使用的认证方式,推荐使用APP认证。 APP认证:表示由ROMA API进行API请求的安全认证。 华为IAM认证:表示通过IAM服务进行安全认证。
删除应用是否会删除关联的实例? 不会。 删除应用只是删除应用和实例的关联关系,并不会删除实例本身的任何资源。
ROMA API中管理员以及IAM用户创建的应用是隔离的,无法互相访问。如果用户想分配权限给不同的IAM用户,需要手动在应用管理内的权限管理进行分配,或在IAM中给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考:
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 根据下表相关任务,了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务,开放给其他用户使用。 单击对应API
管理中心 实例管理 应用管理
简易认证指APP认证方式下调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,ROMA API也仅校验AppCode,不校验请求签名,从而实现快速响应。 注意仅支持HTTPS方式调用,不支持HTTP方式。具体使用请参考管理应用。 说明: