检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。
Service,简称TMS)中过滤查询资源、分析资源及管理资源。 操作步骤 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待添加标签的实例上,单击“查看控制台”或实例名称。 在“标签”页签中,单击“添加标签”。 标签由键和值组成,值可以为空。 如您的组织已经设定API网关服务的相关标签
req_uri, auth_type, env_id, type,status, tags] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、group_id、req_protocol、req_method、req_ur
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 否 String API的编号 name 否 String API的名称 group_id 否 String
env_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:app_id、 api_id 、 api_name、group_id、group_name、env_id、page_size、page_no。 URI中的参数说明如下表所示。
流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。
api_name, group_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:app_id、api_id、api_name、group_id、env_id、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3
仅在API请求的“请求Path”中存在“{}”时,支持修改。 查询参数 Query的参数与参数值。 请求头 HTTP Headers的参数与参数值。 请求体 仅在API请求的“Method”定义为“PATCH”/“POST”/“PUT”时,支持修改。 不同类型的请求,调试界面展现的信息项有差异。 添加请求参数后,单击“发送请求”。
group_id String API所属分组的编号 group_name String API所属分组的名称 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API的发布记录编号 signature_name
group_id String API所属分组的编号 group_name String API所属分组的名称 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API的发布记录编号 signature_name
String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time Timestamp 已绑定的流控策略的绑定时间 auth_type String API的认证方式 req_uri
导入API到已有分组 功能介绍 导入swagger格式的文件, 在已有分组中创建或更新API。swagger文件支持json以及yaml格式。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI PUT /v1.0/apigw/openapi?group_id={0}&mode={1}
为了方便管理API的生命周期,API网关定义了API受限使用范围,这个受限使用的范围,称为环境,例如API的测试环境,开发环境等。 环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。 调用不同环境的API,一般通过在API调用的请求头增加指定的头部参数,
API列表”,单击API名称进入API详情,在“API运行”页签的“前端配置 > 前端定义”中查看已发布的环境。 获取API的认证信息 APP认证(签名认证)在对API请求进行加密签名时,需要用到API所授权凭据的Key和Secret。在APIG实例控制台选择“API管理 > 凭据
js)示例 在工程中引入signer.js。 var signer = require('./signer') var https = require('https') 生成一个新的Signer,填入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例,运行本
绑定API。注意,只有通过APP认证的API才能被绑定。 在已创建凭据所在行,单击“绑定API”。 选择环境、API分组和API。 单击“确定”,完成API绑定。 添加APPCode认证信息。 在凭据列表中单击已创建的凭据名称,进入凭据详情。 在“AppCodes”区域,单击“添加AppCode”。 在弹窗中选择“自动生成”生成方式。
查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。
调试APIG创建的API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API绑定了插件策略或传统策略,在调试API时,策略均不生效。 调试API时,后端超时时间最大支持60s。
请求消息中单独传递它,所以在此单独强调。 URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint:指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从终端节点中获取。例如APIG服务在“华北-北