检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
填写如表1所示信息。 表1 自定义认证参数 信息项 描述 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。 后端:对后端服务的访问授权。 函数地址 选择在FunctionGraph中创建的函数。 身份来源 设置用于认证的请求参数
将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。
API分组”。 单击分组名称,进入API所属分组的详情页面。 在“分组信息”页签的“域名管理”区域,找到已绑定的独立域名,在“支持http to https自动重定向”列开启重定向功能。 验证重定向是否生效 通过浏览器采用https协议调用API。 在浏览器的地址栏中输入“https://API请求路径”后回车。
仅在API请求的“请求Path”中存在“{}”时,支持修改。 查询参数 Query的参数与参数值。 请求头 HTTP Headers的参数与参数值。 请求体 仅在API请求的“Method”定义为“PATCH”/“POST”/“PUT”时,支持修改。 不同类型的请求,调试界面展现的信息项有差异。 添加请求参数后,单击“发送请求”。
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/authorizers 请求消息 表2 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
流控策略管理(待下线) API绑定流控策略(待下线) 设置特殊流控(待下线) ACL策略管理(待下线) API绑定ACL策略(待下线) 概要查询(待下线) 签名密钥管理(待下线) 签名密钥绑定关系管理(待下线) 域名管理(待下线) VPC通道管理(待下线) API导入导出(待下线)
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。
分组信息表 信息项 描述 分组名称 API分组名称,用于将API接口进行分组管理。 描述 对分组的介绍。 完成分组信息填写后,单击“确定”,创建API分组。 创建分组成功后,在“API分组”页面的列表中显示新创建的API分组。 API分组创建后,系统为分组自动分配一个内部测试用的子域
APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps 请求消息 表2 参数说明
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境
响应消息 表5 参数说明 名称 类型 说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type String VPC通道的成员类型。
或者铂金版,并且对现有业务没有影响。 实例版本单价,请参考价格详情中的按需计费价格。 公网带宽 使用的公网入口和公网出口带宽大小。 购买时长 使用实例或公网带宽的时间长度,按小时计费,精确到秒。 购买个数 实例的个数。 假设您计划使用1个专业版实例,开启公网出口,公网带宽大小为5
配置。 简单请求的跨域访问 如果是创建新的API,在定义API请求时,打开“支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 图2 支持跨域 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“Method”为“OPTIONS”的API,作为预检请求。
云和子网。请注意:创建的VPC与APIG实例必须在相同的区域。 在创建APIG实例前,确保已存在可用的安全组。 APIG实例可以使用当前账号下已创建的安全组,也可以使用新创建的安全组,请根据实际需要进行配置。创建安全组的操作步骤,请参考创建安全组。 请添加表1所示安全组规则,其他规则请根据实际需要添加。
(可选)添加策略后端。 添加多个后端策略后,通过不同的策略条件,请求被转发到不同的后端服务中。 单击添加策略后端。 后端策略增加的参数,具体如表6所示,其他参数说明参考表4、表5。 表6 后端策略参数 参数 说明 后端策略名称 您自定义的名称,用于识别不同的后端策略。 支持英文、数字、下划线和中
使用Path不转义的功能请参见表2。 表2 Path不转义影响的功能 功能 描述 API前端定义的Path 请求发送时使用的Path api_uri_no_escape开关关闭 api_uri_no_escape开关开启 API定义 APIG进行匹配路由的Path /{path}
String API的请求协议 HTTP HTTPS app_key 否 String 调试请求使用的APP的key app_secret 否 String 调试请求使用的APP的密钥 domain 否 String API的访问域名,如果使用自定义入方向端口的特性时,需要带上端口信息,用冒号分隔,例如test
注请求调用的结果,服务端收到请求后将请求排队,排队成功后请求就返回,服务端在空闲的情况下会逐个处理排队的请求。 后端超时 参考表4中的后端超时。 后端认证 参考表4中的后端认证。 表6 Mock类型定义后端服务 服务参数 参数说明 Mock自定义返回码 选择API响应的HTTP状
更新后端实例 功能介绍 更新指定的VPC通道的后端实例。更新时,使用传入的请求参数对对应云服务组的后端实例进行全量覆盖修改。如果未指定修改的云服务器组,则进行全量覆盖。 引用负载通道类型的负载通道不支持更新后端实例。 调用方法 请参见如何调用API。 URI PUT /v2/{p