更新时间:2024-07-29 GMT+08:00
响应缓存策略说明
您可以通过配置响应缓存策略将后端服务(服务端)返回的应答缓存在API网关中,当客户端发送相同的请求时,网关不用向后端传递请求,直接返回缓存的应答。有效降低后端的负荷,同时减少API调用的延迟。
当使用响应缓存策略时,后端的响应内容会缓存到API网关中,此时API网关不支持缓存数据加密,对于响应中的敏感数据存在安全风险,请谨慎配置策略。
响应缓存策略原理图如下:
使用限制
- 已了解前提条件。
- 响应缓存策略仅支持使用GET、HEAD方法的API。
- 超过1M的响应体不会被缓存。
- 用于后端响应内容的缓存大小为128m。
- API网关遵守后端应答中的Cache-Control头的约定来处理缓存,如果后端不返回Cache-Control头,则默认缓存,使用策略中配置的ttl字段作为缓存超期时间。
- API网关默认不处理客户端的Cache-Control头,可以通过策略中的client_cache_control来进行配置。
- Cache-Control拓展缓存指令不是核心HTTP缓存标准文档的一部分,本策略不支持拓展缓存指令。
Cache-control: immutable Cache-control: stale-while-revalidate=<seconds> Cache-control: stale-if-error=<seconds>
- API网关仅支持缓存Content-Type、Content-Encoding、Content-Language头,如需要缓存更多的Headers,请在策略的“允许缓存的后端响应头”参数处添加,但是无法添加API网关增加的系统响应头(x-apig-*,x-request-id等)。
配置参数说明
参数 |
说明 |
---|---|
响应缓存键 |
配置参数作为响应缓存键,用于区分不同的缓存。
|
HTTP参数 |
根据HTTP响应码和缓存时长来决定是否缓存,以及缓存的有效时间。 如果不配置HTTP参数,那么HTTP响应码默认值为200,取值范围:200-599。缓存时长默认值为300s,取值范围:1s~720000s。 |
缓存策略模式 |
网关通过客户端请求中的Cache-Control请求头来处理缓存,默认拒绝所有客户端带Cache-Control头的请求。
|
允许缓存的后端响应头 |
对于后端的响应Headers,默认仅支持缓存Content-Type,Content-Encoding,Content-Language头。如果需要缓存更多的Headers,请在“允许缓存的后端响应头”处添加,但是无法添加API网关增加的系统响应头(x-apig-*,x-request-id等)。 |
脚本配置示例
{ "cache_key": { "system_params": [ "$context.sourceIp", "$context.requestId" ], "parameters": [ "demo_parameters" ], "headers": [ "demo_header" ] }, "cache_http_status_and_ttl": [ { "http_status": [ 200 ], "ttl": 300 } ], "client_cache_control": { "mode": "apps", "datas": [ "demo_app_id_1,demo_app_id_2" ] }, "cacheable_headers": [ "demo_cacheable_headers_1,demo_cacheable_headers_2" ] }
父主题: API策略