检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言
基本概念 应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
者、API管理者和API消费者角色和流程来定义API的生命周期,包含了API设计、API实现、API管理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转,并不断演进。 应用是一个系统资源的集合,API的全生命周期是在应
自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制
后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。
选择是否开启绿色通道。 说明: 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后,需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。 单击“确定”,完成授权。
使用自定义认证调用API 如果您希望使用自己的认证方式,可以在函数服务中编写一个函数,将其作为您的认证服务。 使用无认证调用API 对API请求不进行认证。 通过多种开发语言对后端服务进行签名 指导API开放者通过创建后端签名,确保后端服务的安全。
1 API设计 支持API整体的规划和设计,提供Mock调测和规范性检查。 API设计 2 API管理 支持API服务和API策略能力,提供API服务定义和策略管理。 支持API创建、调试和发布功能。 API管理 3 API消费 支持从服务中挑选的部分API组合成API产品,以及
L1:基本功能验证,可用于继承特性的基本功能验证、迭代验收前的基本功能验证等。 L2:重要特性验证,可用于测试版本(非回归版本)中功能测试。 L3:一般功能/非重要功能验证,包括对基本/重要功能的异常测试。 L4:非常特殊输入、场景、阈值条件的用例。 用例描述 用例的描述信息。 选择API接
不推荐 不推荐表示产品待下架。待下架的产品不推荐用户订阅,已订阅用户仍可继续使用,直到产品下架。 选择待下架的API产品,单击产品名称。 选择待下架版本,单击“不推荐”。 填写不推荐申请,单击“确定”。 审核申请通过后,产品不推荐成功。 下架 不推荐的API产品暂停对外提供服务,可以将API产品从API目录中下架。
访问控制策略信息 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括允许和禁止。 和“限制类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 单击“增加IP
根据API使用的安全认证方式,还要获取相关的请求认证信息: APP认证: 签名认证:向API管理者获取该API所授权应用的Key和Secret(或客户端的AppKey和AppSecret),以及用于调用API的SDK。 简易认证:向API管理者获取该API所在应用的AppCode。 其他认证:
操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“环境管理”页签。 单击“创建环境”。 根据下表参数说明,配置环境信息。 表1
户来查看和使用。 具体操作请参考应用授权。 编辑应用 支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”,即可编辑应用信息。 删除应用 已创建的应用不再提供服务,可以将应用删除。 在搜索框中输入需要删除的应用名称。 单击对应应用所在行的“删除”,即可删除应用信息。
删除不再使用的策略。 单击策略名称,进入策略详情。 未绑定API的策略,单击右上角“删除”。 已绑定API的策略,在“关联API”区域“解除”后,单击右上角“删除”。 单击“确定”。 绑定API 将策略与API绑定。 单击策略名称,进入策略详情。 单击“绑定API”。 选择服务和API后,单击“确定”。
分析日志 快速获取并分析API的调用日志。 前提条件 已调用API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。
略,允许/禁止某个IP地址的客户端访问API。 绑定API 在当前凭据下绑定API,绑定后的API拥有当前凭据下的所有策略。 添加AppCode 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧的导航栏选择“API管理 > 凭据管理”。
配置说明 策略名称 填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。 HTTP响应头管
C# 操作场景 使用C#语言调用APP认证的API时,您需要先获取SDK,然后打开SDK包中的工程文件,最后参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Visual S