操作场景
创建云原生网关实例时,实例中的参数例如
nginx_http_client_header_buffer_size、nginx_http_client_max_body_size 等采用默认配置,如果您的业务有特殊要求可以在 TSF 控制台修改对应的参数,优化网关性能。前提条件
操作步骤
1. 登录 TSF 控制台。
2. 在左侧导航栏选择云原生网关 > 实例列表,单击目标实例的“ID”,进入网关实例基本信息页面。
3. 在基础信息页面,选择参数配置,进入参数配置页面。左侧以 JSON 格式展示所有支持修改的系统参数,右侧展示参数说明列表,您可通过参数名搜索,查看该参数支持的默认值和可选值。
4. 单击左上角的修改参数,编辑 JSON 内容,修改参数值为合适的内容。单击保存,实例将进行 Kong reload 操作,完成参数修改,修改后立即生效。
注意:
系统参数值均为字符串,修改时需带英文双引号("")。
默认展示实例初始参数值,当前实例该参数未设置则展示为 null。
Access Log 日志格式的修改,在控制台的 数据观测 > 默认日志 > 编辑日志规则中修改,请参见 查看默认日志。
参数修改会触发 reload 操作,该操作可能会导致长连接中断,请谨慎操作。
参数说明
一、TLS 协议与加密
lua_ssl_protocols
作用:插件等 Lua 出站连接(cosocket)使用的 TLS 版本。默认 TLSv1.1 TLSv1.2 TLSv1.3。
说明:不影响客户端入站,也不影响反向代理到上游服务的 HTTPS。
ssl_protocols
作用:客户端 → 网关(入站)支持的 TLS 版本。默认 TLSv1.2 TLSv1.3。
说明:仅当 ssl_cipher_suite=custom 时生效;默认 intermediate 下该参数被忽略,入站实际为 TLSv1.2 TLSv1.3。启用 TLSv1.1 需将 ssl_cipher_suite 设为 old。
ssl_cipher_suite
作用:决定入站实际生效的 TLS 版本与加密套件。默认 intermediate(即 TLSv1.2 TLSv1.3)。
说明:可选 modern / intermediate / old / fips / custom;启用 TLSv1.1 须设为 old。
ssl_ciphers
作用:自定义加密套件列表。默认空。
说明:仅当 ssl_cipher_suite=custom 时生效,其他取值下被忽略。
二、获取真实客户端 IP
real_ip_header
作用:指定从哪个请求头获取真实客户端 IP。默认 X-Forwarded-For。
说明:需与 trusted_ips 配合才生效——仅当请求来自 trusted_ips 中的可信代理时,才会采用该请求头的值作为客户端 IP;否则以与网关直连的 IP 为准。
trusted_ips
作用:可信代理的 IP/网段白名单,只有来自这些地址的 X-Forwarded-* 请求头才会被采信。默认已包含网关前置负载均衡的网段。
说明:若在网关前还有自建代理/WAF,需将其 IP 加入本列表,否则解析到的“客户端 IP”会是该代理的 IP。
real_ip_recursive
作用:是否递归解析 X-Forwarded-For 以定位真实客户端 IP。默认 off。
说明:off 时取 XFF 中最后一个地址;on 时从右向左跳过可信代理、取最后一个非可信地址。网关前存在多级代理(如 CLB + WAF)时建议开启。
三、请求体大小
nginx_http_client_max_body_size
作用:允许的客户端请求体最大大小。默认 0。
说明:0 表示不限制(并非“禁止上传”);如需限制则改为具体值,例如 10m。
四、响应压缩
nginx_http_gzip
作用:是否对响应启用 gzip 压缩。默认 off。
说明:其余 gzip_* 参数(压缩级别、类型、最小长度等)仅在 gzip=on 时生效,默认 off 下不起作用。
五、响应头
headers
作用:控制网关注入的响应头。默认 server_tokens,latency_tokens。
说明:server_tokens 控制 Server 头(含网关版本),latency_tokens 控制 X-Kong-Proxy-Latency、X-Kong-Upstream-Latency 延迟头;出于安全需要隐藏时,从该列表移除对应项。