检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Asynchronous:异步调用。客户端不关注请求调用的结果,服务端收到请求后将请求排队,排队成功后请求就返回,服务端在空闲的情况下会逐个处理排队的请求。 后端超时 请求超时时间,1 ~ 60000ms。 后端认证 当您的后端服务需要对API调用增加自己的认证,则需要开启后端认证。
API的产品架构、功能和基础知识,有助于您快速准确的找到与实际业务匹配的功能。 产品介绍 什么是ROMA API 产品优势 应用场景 约束与限制 03 入门 如何实现一个完整的API全生命周期管理,您可以从初级使用者或中级使用者快速上手。 快速入门 初级使用者入门 中级使用者入门 05 实践 弹性云服务器(Elastic
API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 根据下表相关任务,了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务,开放给其他用户使用。
的安全保护。 支持区域:华北-北京一、华北-北京四、华东-上海一、华南-广州 如何创建虚拟私有云? VPC服务介绍【视频】 VPC服务介绍【视频】 OBS 2.0支持API设计 主要介绍API设计者如何设计API文件。在API设计和变更阶段指导设计者遵从API格式规范,提升企业API的交付质量。
配置网关响应 网关响应指ROMA API未能成功处理API请求,从而产生的错误响应。ROMA API提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API服务管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
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及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A
已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 根据下表相关任务,了解如何管理实例。 表1 实例相关任务 相关任务 使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。
API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 应用管理”。 根据下表相关任务,了解如何管理应用。 表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务,了解如何管理API产品。 表1 管理产品 相关任务 使用场景 操作步骤 创建新版本 创建产品新版本,同步产品基本信息,可自行添加API。 单击需要创建新版本的产品名称。
API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。 根据下表相关任务,了解如何管理策略。 表1 管理策略 相关任务 使用场景 操作步骤 编辑策略 修改策略信息。 选择需要编辑的策略,或单击策略名称,进入策略详情。 单
提供简单GET请求样例。 DescriptionWithGFM 提供如何在API的描述信息中使用markdown语法,使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore
响应头。 skip:跳过 当API响应中存在指定的响应头时,跳过当前响应头。 当API响应中存在多个与指定响应头相同名称的响应头时,均不作处理直接返回。 当API响应中不存在指定的响应头时,添加当前响应头。 add:新增 无论API响应中是否存在指定的响应头,都添加当前响应头。 脚本配置示例
认证模式1。 28 access_model2 认证模式2,开启双重认证时,为自定义认证编号。 29 inner_time apig的内部处理时长,单位秒。 30 proxy_protocol_vni VPC终端节点的虚拟网络标识。 31 proxy_protocol_vpce_id
return "Hello, Devstar!"; } } 添加的代码中: @RestController表明这个类是可以处理请求的控制器类。 @GetMapping("/")表明使用hello()方法来应答由http://localhost:8080/发出的请求。
path”,“Target”选择工程下的“backend_signature.py”文件,单击“OK”,完成工程配置。 校验后端签名示例 示例演示如何编写一个基于Flask的服务器,作为API的后端,并且实现一个wrapper,对API网关(即API管理)的请求做签名校验。 API绑定签
根据实际情况修改参数后使用。具体代码说明请参考校验后端签名示例。 sdk-request:签名算法的调用示例。 校验后端签名示例 示例演示如何编写一个基于ASP.Net Core的服务器,作为API的后端,并且实现一个IAuthorizationFilter,对API网关(即API管理)的请求做签名校验。
“ApigatewaySignatureFilter.java”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考校验后端签名示例。 校验后端签名示例 示例演示如何编写一个基于Spring boot的服务器,作为API的后端,并且实现一个Filter,对API网关(即API管理)的请求做签名校验。 A
路径:接口请求的路径。请求路径可以包含请求参数,请求参数使用{}标识,例如/a/{b},也可以通过配置'+'号做前缀匹配,例如:/a/{b+}。 网关响应 网关响应指未能成功处理API请求,从而产生的错误响应。ROMA API提供默认的网关响应(default)。如需创建网关响应,请参考配置网关响应。 匹配模式 分为两种模式: