检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调试API API创建后需要验证服务是否正常,控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。
HTTP响应头管理策略 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA
某个IP地址的客户端访问API。 绑定API 在当前凭据下绑定API,绑定后的API拥有当前凭据下的所有策略。 添加AppCode 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧的导航栏选择“API管理 > 凭据管理”。
效降低开发成本。 实现API的内部市场 ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
创建Tag 对API接口进行分类处理,方便筛选或查找API接口。 在页面中单击API设计文件名称,进入API编辑页面。 单击“表单”页签。 在“API列表”区域,单击。 在弹窗中填写Tag信息后,单击“确定”。 创建API 在API设计文件中创建多个API接口。 在页面中单击API设计文件名称,进入API编辑页面。
范性检查。 API设计 2 API管理 支持API服务和API策略能力,提供API服务定义和策略管理。 支持API创建、调试和发布功能。 API管理 3 API消费 支持从服务中挑选的部分API组合成API产品,以及上架到API目录,供API消费者订阅后调用。 API消费 4 API分析
在需要同步的API所在行,单击“同步”。 查看API 查看API产品下的API详情。 选择API所属产品,单击产品名称。 在“版本列表”中选择版本。 选择API,单击“查看API”,查看监控视图、前端配置和后端配置等信息。 移除 API产品不需要某个API时,可将API从未上架产品中移除,即解除API与产品的绑定关系。
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access
实例管理 购买实例 管理实例 配置参数 创建负载通道 创建环境 分析日志 父主题: 管理中心
创建API策略 支持通过策略的方式,为API提供灵活的扩展能力。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。
API允许使用服务分配的子域名或服务绑定的域名调用API,无需另外配置。 使用IP调用API ROMA API的实例配置参数“app_route”已设置为“on”,允许通过IP访问API。 允许使用IP地址调用API,无需另外配置。 配置认证参数。 API认证方式 API请求参数配置 APP认证 签名认证
在需要生成产品的API服务所在行单击“生成产品”。 填写产品基本信息。 在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添加到一个API产品,无法同时添加到多个产品中。
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
使用Java语言调用APP认证的API时,您需要先获取SDK,然后导入示例代码,最后参考调用API示例调用API。 本章节以IDEA为例介绍。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 已安装IDEA,如果未安装,请至IDEA官方网站下载。
前提条件 API已发布。 配置跨域访问控制 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。
来校验API请求是否合法。 同一个环境中一个API只能添加一个签名密钥,一个签名密钥可以添加到多个API上。 前提条件 API已发布。 配置签名密钥 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 >
密钥。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 在“域名管理”区域
客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关(即API管理)除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时间差大于15分钟,API网关将拒绝请求。 父主题: 使用IAM认证调用API
调用API 调用已发布的API 配置跨域访问API 错误码 父主题: API消费