检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
认证前准备 APP认证方式调用API,需要提前获取如下信息: 访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。
I调用示例调用API。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装IntelliJ IDEA,如果未安装,请至IntelliJ IDEA官方网站下载。
管并定期修改访问密钥。修改访问密钥的方法为删除旧访问密钥,然后重新生成。 企业联邦用户不能创建访问密钥,但可以创建临时访问凭证(临时AK/SK和SecuritityToken),具体内容请参见:临时访问密钥。 如果您是IAM用户,请在“安全设置>敏感操作>访问密钥保护”确认所属账号是否开启访问密钥保护。
行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端,输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量,保存文件并退出编辑器。
您可以进行以下操作: 规则集管理 启用规则集 根据业务需求选择适用于API设计文件规范性检查的规则集。 创建规则集 根据业务需求创建规则集。 设置无需检查的接口 设置无需规范性检查的接口。 配置扩展字段 支持统一自定义扩展字段,指定显示区域,字段名必须以“x-”开头。 启用规则集 登录ROMA
ey”已设置为“on”,开启app_api_key认证。 在API请求中添加Header或Query参数“apikey”,参数值为获取API的请求信息中获取到的Key或AppKey。 app_secret认证 ROMA API的实例配置参数“app_secret”已设置为“on”
操作场景 使用C语言调用APP认证的API时,您需要先获取SDK,参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 安装openssl库。 apt-get install libssl-dev
享策略,则以绑定的策略为准。 若某个请求路径下有OPTIONS方法的API,则该请求路径下的所有API均不允许绑定跨域资源共享策略。 为API绑定策略时,API的请求方法必须为allow_methods中允许的请求方法。 配置参数说明 表1 配置参数说明 参数 配置说明 allowed
使用C++语言调用APP认证的API时,您需要先获取SDK,参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 安装openssl库。 apt-get install libssl-dev
AgEwg 调用API,请参考认证前准备获取域名、请求方法和URL,并在请求消息头中增加“X-Auth-Token”,“X-Auth-Token”的取值为1中获取的Token。参数请根据实际情况填写。 curl -X 请求方法 域名+URL -H "x-auth-token: $Token"
使用Android语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Android Studio,如果未安装,请至Android Studio官方网站下载。
API示例调用API。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Python安装包(可使用2.7.9+或3.X),如果未安装,请至Python官方下载页面下载。
API示例调用API。 本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Go安装包,如果未安装,请至Go官方下载页面下载。 获取并安装IntelliJ
最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型”为“NUMBER”时,设置参数值的最小值。 示例 参数值的填写示例。 描述
使用C#语言调用APP认证的API时,您需要先获取SDK,然后打开SDK包中的工程文件,最后参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Visual Studio,如果未安装,请至Visual Studio官方网站下载。
载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。 下载JavaScript
查看API 查看API产品下的API详情。 选择API所属产品,单击产品名称。 在“版本列表”中选择版本。 选择API,单击“查看API”,查看监控视图、前端配置和后端配置等信息。 移除 API产品不需要某个API时,可将API从未上架产品中移除,即解除API与产品的绑定关系。 选择API所属产品,单击产品名称。
数请求方法为“POST”。如需创建自定义后端,请参考创建用于前端认证的函数后端或创建用于后端认证的函数后端。 身份来源 设置用于认证的请求参数。 当“类型”为“前端”,且“缓存时间”不为0时,必须设置此参数。使用缓存时,此参数将作为搜索条件来查询认证结果。 缓存时间 设置认证结果缓存的时间。
凭据策略用于API运行时的策略管理,支持配置APPCode、绑定凭据配额策略和绑定访问控制策略,且只有管理员(IAM用户拥有“Tenant Administrator”权限)能设置。 凭据策略分三种类型:集成凭据、订阅凭据和客户凭据(集成凭据由ROMA实例下的集成应用同步创建;订阅凭据通过订阅产品后,在产品所属实例下