GraphQL Limit Count 配置选项
graphql-limit-count 插件在可配置的时间窗口内限制 GraphQL 文档的累计成本,默认使用选择集深度作为度量。 配置涵盖静态设置、插件参数和插件元数据。
静态配置
网关默认最多读取 1 MiB 的 GraphQL 请求数据。如果 GraphQL 文档或变量可能产生更大的请求体,请提高此上限。以下示例将其提高到 2 MiB(2,097,152 字节):
- 主机或 Docker
- Kubernetes (Helm)
对于主机或 Docker 部署,配置以下设置:
graphql:
max_size: 2097152
然后重新加载网关,使更改生效。
对于 2.16.0 或更高版本的 APISIX Helm Chart,配置以下值:
apisix:
graphql:
maxSize: 2097152
对于 3.10.3 或更高版本的 API7 Gateway Helm Chart,配置以下值:
graphql:
maxSize: 2097152
早期版本的 Chart 未提供此设置对应的值。请升级 Chart,或维护 Chart overlay 或 Helm post-renderer,将 主机或 Docker 标签页中的 graphql.max_size 块添加到生成的 config.yaml。向旧版 Chart 添加上述任一值都不会生效。
将此设置加入部署所用的、纳入版本控制的完整 values 文件。设置 Release 信息,包括已安装的 Chart 及其版本:
export GATEWAY_RELEASE=replace-with-gateway-release-name
export GATEWAY_NAMESPACE=replace-with-gateway-namespace
export GATEWAY_CHART=replace-with-installed-chart-name
export GATEWAY_CHART_VERSION=replace-with-installed-chart-version
应用完整的 values 文件,并保持 Chart 版本不变:
helm upgrade "$GATEWAY_RELEASE" "$GATEWAY_CHART" \
--namespace "$GATEWAY_NAMESPACE" \
--version "$GATEWAY_CHART_VERSION" \
-f values.yaml
参数
有关所有插件都支持的配置选项,请参阅插件通用配置。
count
time_window
window_type
有效值:
fixed或sliding限速窗口算法。
fixed独立计算每个时间窗口;sliding在计算当前成本时对上一个窗口加权,以平滑窗口边界的突发流量。在 API7 企业版 3.9.14、3.10.1 和 APISIX 3.18.0 中引入。
sync_interval
有效值:
-1或大于等于0.1;必须小于顶层数值类型的time_window本地计数器同步到 Redis 的间 隔,以秒为单位。适用于
redis、redis-cluster和redis-sentinel。-1表示每次请求都同步。延迟同步可以减少 Redis 往返次数,但会使限速执行略为宽松。如果运行时适用的
time_window小于或等于sync_interval,网关会直接同步该请求。在 API7 企业版 3.9.14、3.10.1 和 APISIX 3.18.0 中引入。
rules
按顺序应用的限流规则数组。
rules与顶层count和time_window二选一配置,不能同时使用。count
time_window
key
用于计数请求的 Key。支持内置变量组合,每个变量必须以美元符号(
$)为前缀。如果 Key 无法解析,则不会应用该规则。header_prefix
插入到该规则限流响应头中的前缀。例如,
foo会生成X-foo-RateLimit-Limit、X-foo-RateLimit-Remaining和X-foo-RateLimit-Reset。
cost_strategy
有效值:
depth、complexity或node_quantifierGraphQL 文档原始成本的计算方式。
depth按选择集的嵌套深度计算,并且仍是默认值。complexity对查询解析的节点计分。node_quantifier只对匹配的成本装饰能解析出mul_arguments所列参数的节点计分。如果没有节点同时具备匹配装饰和可用量词,原始分数为0。对于
complexity和node_quantifier,插件先加0.01、应用score_factor,再向上取整后计入配额。使用默认系数时,原始分数0的成本为1;大于100的系数会提高该成本。该能力在 API7 企业版 3.10.6 和 APISIX 3.19.0 中引入。
max_cost
有效值:
大于或等于 0在请求到达上游前,以
403 Forbidden拒绝计入配额的成本超过此值的文档。限速器会先计算并处理该成本,因此被此检查拒绝的请求仍可能消耗配额。0表示关闭此检查。在 API7 企业版 3.10.6 和 APISIX 3.19.0 中引入。score_factor
有效值:
大于 0在成本向上取整、计入配额并与
max_cost比较之前应用的缩放系数。该能力在 API7 企业版 3.10.6 和 APISIX 3.19.0 中引入。resolve_variables
如果为 true,则在计算成本时解析已提供的 GraphQL 变量、操作声明的变量默认值,以及上游 schema 中的参数默认值。默认开启可确保以变量提供的量词计入其解析值。该能力在 API7 企业版 3.10.6 和 APISIX 3.19.0 中引入。
introspection_endpoint
有效值:
以http://或https://开头用于对上游 GraphQL Schema 进行内省的端点;
complexity和node_quantifier策略需要该 Schema 来匹配成本装饰。未设置时从上游推导。每个 Worker 会在其生命周期内缓存该 Schema。在 API7 企业版 3.10.6 和 APISIX 3.19.0 中引入。introspection_headers
schema 内省需要凭据时发送的请求头。在数据面启用数据加密后,该字段会加密落盘。该能力在 API7 企业版 3.10.6 和 APISIX 3.19.0 中引入。
key_type
有效值:
var、var_combination或constant键的类型。
如果
key_type为var,则key被解释为变量。如果
key_type为var_combination,则key被解释为变量组合。如果
key_type为constant,则key被解释为常量。key
用于计数请求的键。
如果
key_type为var,则key被解释为变量。变量不需要以美元符号($)作为前缀。查看内置变量以获取可用变量。如果
key_type为var_combination,则key被解释为变量组合。所有变量都应以美元符号($)作为前缀。例如,要将key配置为使用两个 请求头custom-a和custom-b的组合,key应配置为$http_custom_a $http_custom_b。如果
key_type为constant,则key被解释为常量值。rejected_code
有效值:
介于 200 和 599 之间(含边界值)当请求因超过阈值而被拒绝时返回的 HTTP 状态码。
rejected_msg
有效值:
任意非空字符串当请求因超过阈值而被拒绝时返回的响应体。
policy
有效值:
local、redis、redis-cluster或redis-sentinel限速计数器的存储位置。
local使用各个网关实例的本地内存。Redis 策略通过 单个 Redis 服务器、Redis Cluster 或 Redis Sentinel 部署共享计数器。redis-sentinel策略在 API7 企业版 3.9.14、3.10.1 和 APISIX 3.18.0 中引入。allow_degradation
如果为 true,当计数器后端失败,或变量解析得到的
count或time_window无效时,继续处理请求但不执行限速。如果为 false,这些失败会返回500 Internal Server Error。show_limit_quota_header
如果为 true,则在响应中包含限速响应头,具体如下:
X-RateLimit-Limit显示总配额。X-RateLimit-Remaining显示剩余配额。X-RateLimit-Reset显示算法特定的重置或延迟值(秒)。X-Graphql-Query-Cost显示计入配额的查询成本,在 API7 企业版 3.10.6 和 APISIX 3.19.0 中提供。
group
有效值:
非空用于让插件配置相同的路由通过同一组 ID 共享一个计数器。不要将
group与rules同时配置。redis_host
Redis 节点的地址。当
policy为redis时必填。redis_port
有效值:
大于或等于 1Redis 节点的端口。当
policy为redis时使用。redis_username
policy为redis或redis-sentinel时,用于 Redis ACL 认证的用户名。如果 Redis 仅使用旧版requirepass认证方式,请只配置redis_password,不要配置用户名。redis_password
policy为redis、redis-cluster或redis-sentinel时,用于 Redis 认证的密码。API7 企业版会对密码进行静态加密。在 APISIX 中,请启用数据加密,以 便在存入 etcd 前加密密码。
加密功能在 API7 企业版 3.9.16、3.10.2 和 APISIX 3.18.0 中引入。
redis_database
有效值:
大于或等于 0policy为redis或redis-sentinel时使用的 Redis 数据库编号。redis_ssl
如果为 true,则在
policy为redis时使用 SSL 连接到 Redis。redis_ssl_verify
如果为 true,则在
policy为redis时验证服务器 SSL 证书。redis_server_name
用于 SNI 的 TLS 服务器名称;启用证书验证时,也用于主机名验证。适用于
policy为redis且redis_ssl为true的情况。默 认为redis_host。所选值为 IP 地址时,不发送服务器名称。若通过 IP 地址连接但需要验证 DNS 名称证书,请将该字段设为证书中的 DNS 名称,并启用redis_ssl_verify。该字段在 API7 企业版 3.9.21、3.10.8 和 APISIX 3.19.0 中引入。该字段适用于单节点 Redis 连接器,不适用于 Redis Cluster 或 Sentinel。
redis_timeout
有效值:
大于或等于 1Redis 超时时间(毫秒)。当
policy为redis或redis-cluster时使用。redis_keepalive_timeout
有效值:
redis和redis-cluster:大于或等于 1000;redis-sentinel:大于或等于 1空闲 Redis 连接在连接池中的保留时间,以毫秒为单位。
对
redis和redis-cluster的支持在 API7 企业版 3.9.16、3.10.3 和 APISIX 3.17.0 中引入。对 Redis Sentinel 的支持在 API7 企 业版 3.9.14、3.10.1 和 APISIX 3.18.0 中引入。redis_keepalive_pool
有效值:
大于或等于 1当
policy为redis或redis-cluster时,Redis 的保活连接池大小。此参数在 API7 企业版 3.9.x 系列中自 3.9.16 起可用,在 3.10.x 系列中自 3.10.3 起可用,并且在 APISIX 中自 3.17.0 起可用。
redis_cluster_nodes
非空的 Redis Cluster 节点地址列表。
policy为redis-cluster时必填。请提供多个可访问节点,以便某个节点不可用时,初始发现仍可继续。redis_cluster_name
Redis 集群的名称。当
policy为redis-cluster时必填。redis_cluster_ssl
如果为 true,则在
policy为redis-cluster时使用 SSL 连接到 Redis 集群。redis_cluster_ssl_verify
如果为 true,则在
policy为redis-cluster时验证服务器 SSL 证书。redis_sentinels
Redis Sentinel 节点。
policy为redis-sentinel时必填。host
有效值:
至少 2 个字符Redis Sentinel 节点的主机名或 IP 地址。
port
有效值:
介于 1 和 65535 之间(含边界值)Redis Sentinel 节点的端口。
redis_master_name
Sentinel 节点监控的主节点组。
policy为redis-sentinel时必填。redis_role
有效值:
master或slavepolicy为redis-sentinel时,向 Sentinel 请求的 Redis 角色。redis_connect_timeout
有效值:
大于或等于 1policy为redis-sentinel时,连接 Redis 的超时时间,以毫秒为单位。redis_read_timeout
有效值:
大于或等于 1policy为redis-sentinel时,从 Redis 读取数据的超时时间,以毫秒为单位。sentinel_username
policy为redis-sentinel时,用于 Redis Sentinel 认证的用户名。sentinel_password
policy为redis-sentinel时,用于 Redis Sentinel 认证的密码。API7 企业版会对密码进行静态加密。在 APISIX 中,请启用数据加密,以便在存入 etcd 前加密密码。
加密功能在 API7 企业版 3.9.16、3.10.2 和 APISIX 3.18.0 中引入。
插件元数据
limit_header
表示速率限制总配额的默认响应头名称。该字段在 API7 企业版 3.10.6 和 APISIX 3.19.0 中引入。
remaining_header
表示速率限制剩余配额的默认响应头名称。该字段在 API7 企业版 3.10.6 和 APISIX 3.19.0 中引入。
reset_header
表示速率限制计数器重置前剩余秒数的默认响应头名称。该字段在 API7 企业版 3.10.6 和 APISIX 3.19.0 中引入。