检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
IP地址/域名可以是公网IP(支持云服务器的弹性IP地址、用户自己服务器的公网IP地址、ELB地址)/公网域名,前提需要开启实例的公网出口。可以是内网的IP,不可以是内网域名。 2022年10月30日后创建的实例支持APIG与后端服务tls握手阶段向后端服务传SNI。 路径 后端服务的路径,即服务的uri,可以
对,完成鉴权。关于使用APP认证的方法,具体请参考《API网关开发指南》。 从云商店购买的API,系统自动创建一个应用,无需单独创建应用。 使用无认证/华为IAM认证的API,无需创建应用。 应用配额包括您自行创建的应用和在云商店购买API生成的应用。 创建应用 进入共享版控制台。
id 是 String 流控策略的ID。 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 流控策略的ID name String 流控策略的名称 api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits
查看指定的API在指定的环境上的运行时定义,默认查询RELEASE环境上的运行时定义。 API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。
id 是 String 流控策略的ID。 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 流控策略的ID name String 流控策略的名称 api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits
这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收到请求时,可以校验这个签名,如果签名校验不通过,则该请求不是API网关发出的请求,租户可以拒绝这个请求,从而保证API的安全性,避免API被未知来源的请求攻击。 URI HTTP/HTTPS请求方法以及URI如下表所示
这个API时,就会使用绑定的签名密钥对请求参数进行数据加密,生成签名。当租户的后端服务收到请求时,可以校验这个签名,如果签名校验不通过,则该请求不是API网关发出的请求,租户可以拒绝这个请求,从而保证API的安全性,避免API被未知来源的请求攻击。 URI HTTP/HTTPS请求方法以及URI如下表所示
每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的流控策略的数量 size
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境
枚举 请求参数的枚举值,请求参数的值只能从枚举值中选择,多个枚举值间用英文逗号隔开。 最小长度 参数值的最小长度,仅允许输入数字。 最大长度 参数值的最大长度,仅允许输入数字。 示例 参数值的填写示例。 描述 对于此参数的描述。 单击“确定”,完成入参定义的设置。 单击“下一步”,进入“定义后端服务”页面。
略后端的后端服务类型为其他,可以观察对应的后端地址是否被成功访问。 在“API运行”页面单击“调试”,调试已创建的API。 响应结果中显示“200 OK”,表示API调用成功,并且返回值中有“策略后端”字样,表示设置的策略后端的匹配条件成功匹配到前端自定义认证函数返回体中的con
String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的流控策略的数量 size Integer 本次返回的列表长度 throttles 字典数据类型 本次查询到的流控策略列表 表4 throttles参数说明
api_id 是 String api的ID。 throttle_id 否 String 流控策略的编号 throttle_name 否 String 流控策略的名称 env_id 否 String 绑定的环境编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境
加权最少:结合弹性服务器权重值,将请求转发到具有最少活跃连接数的那台服务器。 源地址哈希:由请求的来源IP地址决定请求被转发到哪一台云服务器,相同源地址的请求始终会转发到同一台服务器,除非该云服务器不可用。 URI哈希:由请求的路径决定请求被转发到哪一台云服务器,相同路径的请求始终会转发到同一台服务器,除非该云服务器不可用。
实例ID,可从API网关控制台的专享版实例信息中获取。 api_id 是 String api的ID。 throttle_id 否 String 流控策略的编号 throttle_name 否 String 流控策略的名称 env_id 否 String 绑定的环境编号 page_size
使用实例的私有地址调用API。 在创建实例时,建议配置和您其他关联业务相同负载,确保网络安全的同时,方便网络配置。 安全组 安全组类似防火墙,控制谁能访问实例的指定端口,以及控制实例的通信数据流向指定的目的地址。安全组入方向规则建议按需开放地址与端口,这样可以保护实例的网络安全。
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非
配置API的响应缓存 您可以通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时A
单击“下一步”,进入配置API的后端信息。 配置API的后端信息 支持定义多个策略后端,即满足一定条件后转发给指定的API后端服务,用以满足不同的调用场景。例如为了区分普通调用与特殊调用,可以定义一个“策略后端”,通过调用方的源IP地址,为特殊调用方分配专用的后端服务。 除了定义一个默认的API后端