检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。 填写上架申请,单击“确定”。 审核申请通过后,产品上架成功。 后续操作 如需实现创建新版本、下架、不推荐等操作,请参考管理API产品。 父主题:
访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后,需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。 单击“确定”,完成授权。 下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证,填写申请描述。 您可以使用已有的凭证或者新建凭证,新建凭证具体操作请参考创建凭证。 单击“确定”,订阅申请成功。 在左侧导航栏单击“审核管理”,审核申请通过后,订阅产品完成。
对后端服务进行签名 Java Python C#
访问日志的字段采用空格作为分隔符,按照顺序,每个字段的含义如下: 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id 请求ID 3 api_id API ID 4 user_id 当使用IAM认证访问时,请求方提供的项目ID 5
requestId 当次API调用生成请求ID $context.stage API调用的部署环境 $context.sourceIp API消费者的源地址 $context.authorizer.frontend.property 前端自定义认证响应的context映射的指定键值对的字符串值
使用app_secret认证时,需同时关闭app_api_key认证方式。 app_route 支持IP访问开关。启用后,非DEFAULT服务下的API可以使用IP地址调用。 backend_client_certificate 后端双向认证开关。启用后,创建API配置后端服务时,可配置后端双向认证。 ssl_ciphers
取用于调用API的SDK。 自定义认证:向API管理者获取请求参数中要携带的自定义认证信息。 无认证:无需认证信息。 调用API 配置请求地址相关参数。 API调用场景 API请求参数配置 使用域名调用API ROMA API允许使用服务分配的子域名或服务绑定的域名调用API,无需另外配置。
创建应用 登录ROMA API控制台。 在控制台单击,选择区域。 在左侧导航栏选择“总览”或“管理中心 > 应用管理”。 单击“创建应用”,填写应用名称和描述。 单击“新增关联区域资源”,选择关联区域。 关联实例资源,单击,选择实例类型。 不支持关联2019年6月份之前创建的ROMA
打开IDEA,在菜单栏选择“File > NEW > Project”。 在弹窗中选择“New Project”,填写并选择以下参数后,单击“Create”。 Name:填写“apig-sdk-maven-demo”。 Build system:选择“Maven” JDK:用户自己的版本。
JavaScript 操作场景 使用JavaScript语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 JavaScript SDK支持Node.js、浏览器等运行环境。 关于开发环境搭建,本章节以IntelliJ IDEA 2018
间格式:YYYYMMDDTHHMMSSZ。如果API发布到非RELEASE环境时,需要增加自定义的环境名称。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
调试API API创建后需要验证服务是否正常,控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
什么是ROMA API ROMA API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。
使用自定义认证调用API Function API通过编写函数脚本实现将多个服务封装成一个服务。 有关API调用的认证帮助,请参考编写函数API脚本(Java Script)。
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
API设计 创建API设计 API设计配置 管理API设计