检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的响应缓存 您可以通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。 当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时A
在API网关控制台选择“开放API > API管理”,单击API的名称进入“调用信息”页面,可获取API的“域名”、“请求方法”和“请求路径”,以及API的基本信息。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息: 认证方式 认证信息 APP认证(签名认证)
当“类型”为“前端”,且“缓存时间”不为0时,必须设置此参数。使用缓存时,此参数将作为搜索条件来查询认证结果。 缓存时间 设置认证结果缓存的时间。 值为0时代表不缓存,最大支持3600秒。 是否发送body 指是否将API请求的body体内容传递给认证函数。body体内容传给函数的方式,与header、query内容传递一致。
为了方便管理API的生命周期,API网关定义了API受限使用范围,这个受限使用的范围,称为环境,例如API的测试环境,开发环境等。 环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。 调用不同环境的API,一般通过在API调用的请求头增加指定的头部参数,
当“镜像协议”为HTTP/HTTPS时设置。 镜像请求的路径,支持* % - _ .等特殊字符,总长度不超过512,且满足URI规范。如果不指定镜像请求路径,那么默认使用绑定的API的请求路径。 拼接模式 当指定镜像请求的路径后,可以设置请求路径的拼接模式。 replace模式:表示使用指定的“镜像请求路径”作为镜像请求的路径。
POST:请求方法,需替换为获取API的调用信息中获取的请求方法。 {Address}:请求地址,需替换为获取API的调用信息中获取的域名地址。 API调用场景 API请求参数配置 使用域名调用API 使用服务分配的调试域名或服务绑定的域名调用API,无需另外配置。 使用IP调用DEFAULT分组的API A
配置API的插件策略 配置API的跨域资源共享 配置API的响应缓存 配置API的HTTP响应头 配置API的流量控制2.0 配置API的Kafka日志推送 配置API的断路器 配置API的第三方认证 配置API的流量镜像 父主题: 配置API策略
认证的API。 方案优势 在API网关提供的安全认证模式下,用户可根据业务需求,灵活实现自定义认证,保障API的安全性。 约束与限制 API网关支持的自定义认证依赖于函数工作流服务,创建自定义认证前,需要先创建函数。 操作流程 创建函数 创建自定义的前端函数,使用函数服务开发自定义认证。
network_type 否 String 对接函数的网络架构类型。 V1:非VPC网络架构 V2:VPC网络架构 缺省值:V1。 retry_attempts 否 Number 重试次数。 timeout 否 Number 超时时间。 ttl 否 Number 缓存时间。 type 是 String
配置API的断路器 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下,会触发断路器的降级机制,向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略
配置API的前端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,
访问控制策略的名称。支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~64个字符。 类型 控制访问API的类型。 IP地址:限制调用API的IP地址。 账号名:仅适用IAM认证类型的API,限制调用API的账号名。仅支持配置账号名,对账号名及账号名下的IAM用户名做限制,不支持配置IAM用户名。
ken接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 plugins Array of PluginInfo
查询API下绑定的插件 功能介绍 查询指定API下绑定的插件信息。 用于查询指定API下已经绑定的插件列表信息 支持分页返回 支持插件名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instanc
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数,
使用APIG专享版的流量控制2.0策略实现API的精细流控操作流程 假设您对一个API有如下的流控诉求: 默认API流量限制为10次/60秒,用户流量限制为5次/60秒。 对请求头Header字段为“Host=www.abc.com”的限制为10次/60秒。 对请求方法为get且请求路径为“reqPath=
自定义认证配置 推送的日志中,需要携带的自定义认证信息。 前端:填写日志中要携带的前端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。 后端:填写日志中要携带的后端自定义认证的响应字段信息,多个字段间使用英文逗号(,)分隔。 单击“确定”。 如果您需要复制已创建的策略,请在已
使用APIG专享版的流量控制2.0策略实现API的精细流控方案概述 应用场景 当在公网中调用APIG上公开的业务API时,如果不限制API调用的次数,随着用户的不断增加,会引起后端性能的下降,甚至会因为恶意用户发送的大量请求导致网站或程序崩溃。APIG提供了传统流量控制策略,从A
在APIG实例中,为API分组绑定已创建的防护域名。 进入APIG控制台,在左侧导航栏中选择“API管理 > API分组”。 单击已创建的分组名称。 在“分组信息”页签中的“域名管理”区域,单击“绑定独立域名”。 在弹窗中添加已创建的防护域名即可。 在APIG实例中,将“rea
是 boolean 是否支持开启跨域请求的标识。 true:支持。 false:不支持。 开启跨域访问的API请求,响应会增加如下头域: 头域名称 头域值 描述 Access-Control-Max-Age 172800 预检响应最大缓存时间。 单位:s。 Access-Control-Allow-Origin