检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 ROMA API目前提供部分API接口信息。 ROMA实例接口信息请参考:《API参考》。 APIG实例接口信息请参考:《API参考》。
支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二 ROMA API应用场景 ROMA API介绍【视频】 快速入门 OBS 2.0支持虚拟私有云子功能二 虚拟私有云(Virtual Private Cloud,以下简称VPC),为云服务器
运行环境 选择待导出API所在的部署环境。 API 默认导出API服务在所选择环境下的所有API。如果只需要导出个别API,可单击“自定义导出API”,勾选需要导出的API。 API定义范围 选择导出的API服务文件中,API定义字段的类型范围。
ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
api_prom_metrics 当实例为APIG类型时,支持是否启用Prometheus指标接口。启用Prometheus后,您可通过 https://<网关组件IP>:1026/metrics采集到Prometheus格式的API调用统计数据。
调试API API创建后需要验证服务是否正常,控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。
(可选)规范性检查,对接口规范性检查。 (可选)导入到API服务,将已设计的接口导入API服务。 (可选)可视化设计API文件,对接口可视化设计。 (可选)配置SLA。单击。 需要配置SLA的API所在行,单击“配置SLA”。
创建Tag 对API接口进行分类处理,方便筛选或查找API接口。 在页面中单击API设计文件名称,进入API编辑页面。 单击“表单”页签。 在“API列表”区域,单击。 在弹窗中填写Tag信息后,单击“确定”。 创建API 在API设计文件中创建多个API接口。
调用API示例 获取Token,并设置成环境变量,Token用于后续调用其他接口鉴权。
步骤十一:订阅产品 在API目录中,订阅产品。 步骤十二:调用API 为简单起见,此处我们使用接口测试工具,通过APP认证方式中的凭证来实现对API的调用。 准备工作 已准备虚拟私有云、子网和安全组。 已在本地PC上下载并安装接口调试工具。 步骤一:购买实例 选择实例类型。
= new Signer(); $signer->Key = '4f5f626b-073f-402f-a1e0-e52171c6100c'; $signer->Secret = "******"; 生成一个新的Request,指定方法名、请求url和body(body根据实际的接口请求指定
29 inner_time apig的内部处理时长,单位秒。 30 proxy_protocol_vni VPC终端节点的虚拟网络标识。 31 proxy_protocol_vpce_id VPC终端节点的ID。 32 proxy_protocol_addr 客户端源IP地址。
一个接口生成一个用例:将选择的每个API接口分别都生成用例,即选择多少个API接口生成多少个用例。 用例等级 L0:最基本的功能验证。 L1:基本功能验证,可用于继承特性的基本功能验证、迭代验收前的基本功能验证等。 L2:重要特性验证,可用于测试版本(非回归版本)中功能测试。
设置无需检查的接口 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 在页面右上角单击“API设计配置”。 单击“无需检查的接口”页签。
在新建版本中,单击“添加API”,可添加API接口。 编辑 修改产品基本信息。 在API产品所在行,单击“编辑”。 修改产品信息后,单击“完成编辑”。 如果产品已上架,那么需要提交修改申请。 填写申请描述后,单击“确定”。 审核申请通过后,产品信息编辑成功。
在“API接口”列表勾选需要导入的API,单击“立即导入”。 (可选)单击“全局配置(可选)”,请参考全局配置。 在弹窗中选择是否现在发布API到环境。 若选择“现在发布”,还需要选择API要发布的环境,将API服务下的所有API发布到环境上。
匹配模式 分为两种模式: 绝对匹配:调用的请求Path固定为创建时填写的API请求Path。 前缀匹配:调用的请求Path将以创建时填写的API请求Path为前缀,支持接口定义多个不同Path。
API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API Connect开放给用户调用。API包括基本信息、前后端的请求路径和参数以及请求相关协议。
凭据管理 2 HTTP响应头管理 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。
API网关(即API管理)除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时间差大于15分钟,API网关将拒绝请求。 父主题: 使用IAM认证调用API