检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添加到一个API产品,无法同时添加到多个产品中。 完成产品的配置后,单击“立即创建”,创建API产品。 父主题: API服务管理
API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA AP
认证模式2,开启双重认证时,为自定义认证编号。 29 inner_time apig的内部处理时长,单位秒。 30 proxy_protocol_vni VPC终端节点的虚拟网络标识。 31 proxy_protocol_vpce_id VPC终端节点的ID。 32 proxy_protocol_addr 客户端源IP地址。
访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。 图2 运行环境信息 对于AP
在左侧导航栏选择“管理中心 > 应用管理”。 在“应用管理”中找到2中应用,单击该应用后的“权限管理”进行授权配置。 主账号可以对所有IAM用户创建的应用进行授权配置,IAM用户只能对自己创建的应用进行授权配置。 在弹窗中“用户列表”处勾选要授权的IAM用户,在“已选择”处为已选择的IAM用户配置应用的使用权限。
将已创建的API服务生成产品。 步骤十:上架目录 将生成的产品上架到目录中,供消费者查看和订阅。 步骤十一:订阅产品 在API目录中,订阅产品。 步骤十二:调用API 为简单起见,此处我们使用接口测试工具,通过APP认证方式中的凭证来实现对API的调用。 准备工作 已准备虚拟私有云、子网和安全组。
权限管理 ROMA API中管理员以及IAM用户创建的应用是隔离的,无法互相访问。如果用户想分配权限给不同的IAM用户,需要手动在应用管理内的权限管理进行分配,或在IAM中给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考:
如果策略与API有绑定关系,则策略无法执行删除操作。 创建策略 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。 单击“创建策略”,选择策略类型。
自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。
为产品上架/不推荐/下架/订阅过程提供审核机制,API管理者发起上架/不推荐/下架/订阅请求时,IAM用户(其他管理者)都可以参与到评审中,让更多用户参与到API产品审视中,以确保产品的正确性。 审核流程: 提交申请 查看申请 审核申请 提交申请 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
pem”),将证书内容复制到“证书内容”中即可。 若证书为非pem编码格式,可参考转换证书为PEM格式进行证书格式转换。 密钥 填写pem编码格式的SSL证书密钥。 以文本方式打开待上传证书里的KEY格式或PEM格式的私钥文件(后缀名为“.pem”或“.key”),将私钥复制到“密钥”中即可。 单击“确定”,完成SSL证书的添加。
订阅API产品 API目录相当于一个资产中心,以产品的形式将API资源上架到API目录中,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。
在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添加到一个API产品,无法同时添加到多个产品中。 单击“立即创建”,创建API产品。 如需添加API到产品,请参考添加API到产品。 添加API到产品
licenses\license-referencesource 第三方库license文件 打开工程 双击SDK包中的“csharp.sln”文件,打开工程。工程中包含如下3个项目: apigateway-signature:实现签名算法的共享库,可用于.Net Framework与
前准备。 调用API示例 使用JavaScript SDK生成curl命令。 下载JavaScript SDK的最新版本,并解压。在浏览器中打开demo.html,页面如下图所示。 填入Key、Secret、方法名、请求协议、域名和url。例如: 1 2 3 4 Key=4f5f
API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转,并不断演进。 应用是一个系统资源的集合,API的全生命周期是在应用中实现,因此在开启API的全生命周期管理之前,您需要在“管理中心”先创建应用。 API设计 API设计者
”。 (可选)如果API服务中的API支持HTTPS请求协议,则需要为独立域名绑定SSL证书。否则跳过此步骤。 在域名所在行单击“选择SSL证书”。 在选择SSL证书弹窗中勾选要绑定的SSL证书,然后单击“确定”,完成SSL证书的绑定。 若证书列表中无可用的SSL证书,可单击“创
基本概念 应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
创建流控策略,针对部分API进行流量控制。 每个用户最多创建30个流控策略。 API添加流控策略相当于流控策略同步绑定了API。同一个环境中,一个API只能添加一个流控策略,但一个流控策略可以绑定多个API。 前提条件 API已发布。 创建流量控制 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
在ROMA API请求中添加Header参数“X-Apig-AppCode”,参数值为获取API的请求信息中获取到的AppCode。 双重认证 在API请求参数中增加自定义认证信息进行认证。 凭证认证 在API请求中添加Header参数“X-HW-ID”,获取API的请求信息中获取到凭证信息的Key。