更新日志
3.10.1
发布日期:2026-06-15
不兼容变 更
插件
-
升级说明
jwt-auth现在默认校验 token 的exp(过期)和nbf(生效时间)声明。此前,未设置claims_to_verify(或将其设为空列表)的 consumer 会接受任何签名正确的 token,包括已过期的 token。数据面升级后,这类 token 会被以HTTP 401拒绝。如果你依赖已过期 token 仍被接受,请在升级前评估此行为变更。如需只校验特定声明,请在 consumer 配置中显式设置
claims_to_verify。 -
Batch Requests
升级说明batch-requests插件现在会限制批量请求的规模。流水线子请求的数量由新增的插件元数据选项max_pipeline_items限制(默认1000),超过上限的批量请求会被以HTTP 400拒绝。包含文档之外字段的流水线条目现在会被拒绝,且每批的timeout至少为1毫秒。如果你发送的批量请求超过 1000 个子请求,请在插件元数据中调大
max_pipeline_items。如果客户端发送了未文档化的条目字段,请在升级前移除它们。
升级须知
当数据面启用数据加密(apisix.data_encryption.enable: true)时,以下插件字段现在会在落盘时加密存储(在原有已加密字段之外新增)。请检查你是否使用了这些插件:
- http-logger:
auth_header - kafka-logger:
brokers.sasl_config.password - splunk-hec-logging:
endpoint.token - loggly:
customer_token - openfunction:
authorization.service_token - azure-functions:
authorization.apikey,以及插件元数据master_apikey - ai-aws-content-moderation:
comprehend.secret_access_key - openid-connect:
session.secret - error-log-logger(插件元数据):
kafka.brokers.sasl_config.password
只有这些凭据的落盘表示(etcd / 备份 / 导出)从明文变为密文,Admin API 返回的值不变。由于控制面一升级就会加密这些字段,请将数据面与控制面一起升级(或在依赖该加密前先升级数据面)——新控制面搭配尚不解密这些字段的旧数据面时,会把密文透传给上游。如果你未启用数据加密,则没有任何变化。
此前仅 limit-count-advanced 独有的全部能力——redis-sentinel 策略、滑动窗口计数、在一份配置中设置多个独立限流(rules)、由 NGINX 变量驱动的动态 count 和 time_window、以及延迟 Redis 同步(sync_interval)——现已内置到 limit-count 插件中。既有的 limit-count-advanced 配置可继续原样使用(该插件作为薄封装保留),无需做配置迁移。
一个升级时的影响:对于基于 Redis 的策略,计数器存储格式发 生了变化,且计数器 key 现在带版本号。既有计数器不会被迁移——它们会按各自的 TTL 自然过期——因此限流计数器会在升级时刻重置一次。(local 策略本就在重启时重置。)会有一个短暂的计数重置窗口,无需任何操作。
为了限制内存占用,多个插件现在会在缓冲之前拒绝过大的请求体:
- hmac-auth:当启用
validate_request_body时,请求体大小由新增的max_req_body_size选项限制(默认524288字节,即 512 KiB)。 - forward-auth、ai-proxy、ai-proxy-multi:请求体大小由新增的
max_req_body_size选项限制(默认67108864字节,即 64 MiB),超过上限的请求会被以HTTP 413拒绝。
这些默认值高于 NGINX 默认的 client_max_body_size(1 MiB),因此大多数部署不受影响。如果你确实需要在使用这些插件的 route 上处理更大的请求体(并已相应调大 client_max_body_size),请将 max_req_body_size 调整到匹配的值。
在开发者门户中,凭据的 key-auth key 和 basic-auth password 现在仅在创建或重新生成凭据时返回一次,不再包含在凭据的读取或列表响应中,这与 OAuth client_secret 的现有行为一致。basic-auth 的用户名仍然可见。
请在密钥首次展示时复制并妥善保存。如果密钥丢失,请重新生成凭据以获得新值。任何从凭据读取或列表接口回读这些密钥的集成都需要改为在创建时捕获它们。
独立的 apisix_llm_ttft 指标已被 apisix_llm_latency{type="ttft"} 取代,与 apisix_http_latency 的结构保持一致。如果你的 Prometheus 查询或 Grafana 看板引用了 apisix_llm_ttft,请改为选择 apisix_llm_latency 上 type 标签的 ttft 值。
新功能
插件
- Limit Count
- 此前仅
limit-count-advanced提供的高级限流能力,现在可直接在limit-count中使用:redis-sentinel策略、滑动窗口计数(window_type设为sliding)、在一份配置中设置多个独立限流(rules)、由 NGINX 变量驱动的count和time_window(例如按 consumer 的动态配额)、以及延迟 Redis 同步(sync_interval)。
- 此前仅
- AI 内容安全插件(
ai-aliyun-content-moderation、ai-aws-content-moderation、ai-prompt-guard)- 新增
fail_mode选项(skip、warn或error,默认skip),用于控制当插件绑定在 Consumer 级别、收到非 AI 或非 JSON 请求时的处理方式。skip会让这类请求不经检查直接放行;warn会额外记录一条警告日志;error则拒绝它们。这避免了 Consumer 级绑定的审核插件收到普通(非 AI)流量时报错。
- 新增
- AI Proxy
- 新增描述每个 LLM 请求的内置 NGINX 变量,可用于
access_log格式和 logger 插件:$llm_total_tokens、$llm_stream、$llm_has_tool_calls、$llm_tool_count、$llm_end_user_id、$llm_cache_read_input_tokens、$llm_cache_creation_input_tokens和$llm_reasoning_tokens。已为 OpenAI(Chat 与 Responses)、Anthropic 和 DeepSeek 提供映射。
- 新增描述每个 LLM 请求的内置 NGINX 变量,可用于
- Prometheus
- 新增 LLM 可观测性指标:按请求统计的 prompt token 和 completion token 分布直方图(
apisix_llm_prompt_tokens_dist、apisix_llm_completion_tokens_dist)、总延迟直方图,以及以apisix_llm_latency{type="ttft"}暴露的首 token 时间(TTFT,仅流式请求)。直方图的 bucket 可通过plugin_attr.prometheus配置。 - 为
http_status、http_latency和bandwidth指标新增mcp_request_type和mcp_tool_name标签,从而可以按请求类型(tools/list或tools/call)和工具名称拆分 MCP(Model Context Protocol)流量。这两个标签都可以通过disabled_labels关闭。 - 在指标日志阶段缓存 disabled-labels 映射,而不是每个请求都重建,降低了每请求开销。
- 新增 LLM 可观测性指标:按请求统计的 prompt token 和 completion token 分布直方图(
- AI Proxy Multi
- 为 fallback 机制新增
max_retries和retry_on_failure_within_ms。max_retries限制单个请求在失败后最多重试多少个额外实例;retry_on_failure_within_ms仅在上游于指定时间内失败时才进行 fallback,因此慢失败会直接返回给客户端,而不是再重试(避免长耗时 LLM 请求的延迟翻倍)。
- 为 fallback 机制新增
- OpenID Connect
- 在
session下暴露了lua-resty-session选项(cookie 的 name、path、domain、secure、http_only、same_site,以及 idling、rolling、absolute 超时),因此你可以自定义会话 cookie 名称并设置真正生效的会话有效期。旧的session.cookie.lifetime已废弃 但仍被兼容(映射为absolute_timeout)。 - 对于只在本地校验 token、不调用身份提供方的流程(
bearer_only搭配public_key或use_jwks、private_key_jwt、以及公共客户端 PKCE),client_secret现在是可选的。会话/回调和 introspection 流程仍然必须提供它。
- 在
- Kafka Logger
- 为 Kafka 生产协议新增
api_version选项(0、1或2,默认1)。将api_version设为2可让 broker 记录真实的消息时间戳(Kafka 0.10 及以上);默认值1保留协议兼容性。
- 为 Kafka 生产协议新增
开发者门户
- 双因素认证:开发者可使用 TOTP 验证器 App 保护自己的账号。在账号安全设置中启用 2FA(确认密码、扫描二维码),也可在此关闭;启用后登录会要求输入六位验证码。
- 深色模式:门户支持浅色、深色和跟随系统三种主题,可通过页头的开关切换,应用于整个界面、API 用量图表和文档站,并在多次访问间保持。
- 平台管理后台:新增管理区域(仅限配置的管理员用户),其中的 Users 页面可列出、搜索和分页查看门户用户,修改用户角色、封禁或解封、删除用户;Organizations 页面可按用户成员关系筛选。
- 门户内审批:平台管理员可以在门户新增的 Approvals 页面中查看并处理开发者注册和 API Product 订阅申请。审批与 Dashboard 共享同一数据源,每次处理都会记录操作管理员的身份(Dashboard 的审批列表现在会为门户中做出的处理显示真实的管理员名称)。
- 基于策略的 SSO 登录:登录会根据所输入的邮箱把用户引导到正确的方式(密码、magic link 或 SSO)。管理员可以把邮箱域名映射到 SSO 提供方,并支持锚定、大小写不敏感的正则表达式模式,因此一条规则即可覆盖多个域名。
- 门户内文档站:门户现在在
/docs托管一个与门户风格一致的 Markdown 文档站,带可折叠侧边栏、目录、代码复制按钮、"Copy page" 菜单,以及带高亮匹配片段的内置全文搜索。 - 注册服务条款:新用户需要同意服务条款才能完成注册;服务条款 URL 可配置。
- 简化组织创建:「创建组织」对话框不再要求填写 slug——标识符会根据名称自动分配。
缺陷修复
插件
- JWT Auth
- 修复问题:当 token 的签名格式有误(长度不对或不是合法的 base64url)时,校验器会抛错并返回
HTTP 500,而不是拒绝请求。现在签名格式有误的 token 会以HTTP 401被拒绝。
- 修复问题:当 token 的签名格式有误(长度不对或不是合法的 base64url)时,校验器会抛错并返回
- AI Proxy
- 修复问题:在 passthrough 模式下,发往上游的请求总是以
POST发送,且丢弃了客户端的查询字符串,导致需要在其他方法上携带查询参数的提供方失败(例如 Azure OpenAI 的?api-version=)。现在会转发客户端的方法和查询字符串。 - 修复问题:访问上游 LLM 超时(例如 DNS 解析超时)时返回
HTTP 500而不是HTTP 504。现在上游 LLM 超时会正确返回HTTP 504。
- 修复问题:在 passthrough 模式下,发往上游的请求总是以
- AI Proxy Multi
- 修复问题:在按实例创建健康检查器之后,缓存的节点选择器没有重建,导致某个 worker 可能持续把部分流量路由到已被标记为不健康的实例;对配置了
auth.query或auth.header的实例,主动健康检查探测还可能破坏探测路径。这两个问题均已修复,故障转移和健康检查现在按配置工作。
- 修复问题:在按实例创建健康检查器之后,缓存的节点选择器没有重建,导致某个 worker 可能持续把部分流量路由到已被标记为不健康的实例;对配置了
- Graphql Proxy Cache
- 修复问题:在内存缓存增加
Vary支持后,PURGE请求只清除了旧的缓存槽,而保留了各Vary变体的缓存,因此在 TTL 过期前仍会返回过期响应。现在PURGE会清除所有变体。
- 修复问题:在内存缓存增加
- Body Transformer
- 修复问题:XML 转 JSON 时会在部分 worker 进程上间歇性丢失带命名空间的 key,导致 SOAP 转换以
attempt to index field 'Body' (a nil value)失败。现在带命名空间的 key 总能被保留。格式错误的 multipart 输入现在返回HTTP 400而不是HTTP 500。
- 修复问题:XML 转 JSON 时会在部分 worker 进程上间歇性丢失带命名空间的 key,导致 SOAP 转换以
- Kafka Logger
- 修复问题:由于无法配置 Kafka 生产 API 版本,broker 存储的消息没有可用的时间戳(显示为 1970-01-01)。将新增的
api_version设为2可让 broker 记录真实的时间 戳。
- 修复问题:由于无法配置 Kafka 生产 API 版本,broker 存储的消息没有可用的时间戳(显示为 1970-01-01)。将新增的
- Elasticsearch Logger
- 修复问题:使用某些
{time_format}占位符的动态索引名可能生成被破坏的索引名。现在无效的时间格式会回退为空值(并记录日志),而不是破坏索引名。
- 修复问题:使用某些
- AWS Lambda
- 修复问题:使用 IAM(SigV4)认证时,查询字符串中包含需要转义的字符、多值或无值键会导致签名不匹配(
InvalidSignatureException)。现在规范查询字符串按 SigV4 规范构建。
- 修复问题:使用 IAM(SigV4)认证时,查询字符串中包含需要转义的字符、多值或无值键会导致签名不匹配(
- Proxy Mirror
- 修复问题:镜像 gRPC 请求时把内部 location 名称当作请求路径发送,导致镜像后端以
UNIMPLEMENTED拒绝每次调用。现在镜像请求使用原始的 gRPC 方法路径。
- 修复问题:镜像 gRPC 请求时把内部 location 名称当作请求路径发送,导致镜像后端以
- Request ID
- 修复问题:当
algorithm设为nanoid时,生成器会产生大量重复且格式错误的 ID,并且每生成一个 ID 就泄漏一个文件描述符。现已替换为基于 CSPRNG 的生成器;ID 格式不变,且 ID 现在唯一且格式正确。
- 修复问题:当
- OPA
- 修复问题:配置
send_headers_upstream时,OPA 服务未返回的某个头会在发往上游的请求中保留客户端传入的值,而不是被清除。现在这类头会被清除。
- 修复问题:配置
- SAML Auth
- 修复问题:调试日志被意外保持开启,且认证失败时可能放行请求而不是返回错误。现在已关闭调试模式,认证失败会返回明确的错误。
- CORS
- 修复问题:当配置了
allow_origins_by_regex时,没有Origin头的请求会返回HTTP 500。现在这类请求会被正常处理而不报错。
- 修复问题:当配置了
- Multi Auth
- 修复问题:当底层某个认证插件返回的状态没有错误信息时,插件返回
HTTP 500而不是HTTP 401。现在会返回HTTP 401。
- 修复问题:当底层某个认证插件返回的状态没有错误信息时,插件返回
- DingTalk Auth
- 修复问题:客户端可以传入伪造的
X-Userinfo头并被转发到上游。插件现在会在认证前清除客户端传入的X-Userinfo头,确保上游只收到由插件校验的身份信息。
- 修复问题:客户端可以传入伪造的
- Authz Casdoor
- 修复问题:登录会话没有绑定到 Casdoor token 的有效期,而是回退到会话库的默认值,导致会话可能比 token 存活更久。现在会话会在 Casdoor token 过期时一并过期。
- CAS Auth
- 修复问题:单点登出的
POST请求体为空时返回HTTP 500而不是HTTP 400。现在空请求体的登出请求会被以HTTP 400拒绝。
- 修复问题:单点登出的
- Limit Conn
- 修复问题:由 NGINX 变量解析出的
burst值为0时会被以HTTP 500拒绝,尽管静态的burst为0是合法的。现在变量解析出的burst为0会被接受。
- 修复问题:由 NGINX 变量解析出的
- Limit Req
- 修复问题:在并发压力下,由于读取和写入不是原子操作,基于 Redis 的限流可能被突破。现在限流通过单次原子操作执行。