Limit Req | API 网关文档

参数

请参阅插件通用配置了解所有插件可用的配置选项。

rate
integer
required
vaild vaule:
大于 0
每秒允许的最大请求数。超过此速率但低于 burst 的请求将被延迟。
burst
integer
required
vaild vaule:
大于或等于 0
每秒允许延迟处理的请求数（用于流量整形）。超过 rate 和 burst 总和的请求将被拒绝。
key_type
string
default: var
vaild vaule:
var or var_combination
键的类型。
如果 key_type 为 var，则 key 被解释为变量。
如果 key_type 为 var_combination，则 key 被解释为变量组合。
key
string
required
default: remote_addr
用于计数请求的键。
如果 key_type 为 var，则 key 被解释为变量。变量不需要以美元符号（$）作为前缀。查看内置变量以获取可用变量。
如果 key_type 为 var_combination，则 key 被解释为变量组合。所有变量都应以美元符号（$）作为前缀。例如，要将 key 配置为使用两个请求头 custom-a 和 custom-b 的组合，key 应配置为 $http_custom_a $http_custom_b。
rejected_code
integer
default: 503
vaild vaule:
介于 200 到 599 之间（含边界值）
当请求因超过阈值而被拒绝时返回的 HTTP 状态码。
rejected_msg
string
vaild vaule:
任意非空字符串
当请求因超过阈值而被拒绝时返回的响应体。
nodelay
boolean
default: false
如果为 true，则不延迟 burst 阈值内的请求。
allow_degradation
boolean
default: false
如果为 true，则在插件或其依赖项不可用时，允许网关继续处理请求而不使用该插件。
policy
string
default: local
vaild vaule:
local, redis, or redis-cluster
速率限制计数器的策略。如果为 local，则计数器存储在本地内存中。如果为 redis，则计数器存储在 Redis 实例中。如果为 redis-cluster，则计数器存储在 Redis 集群中。
如果你使用的是 API7 企业版，该选项从版本 3.9.0 开始可用。
redis_host
string
Redis 节点的地址。当 policy 为 redis 时必填。
redis_port
integer
default: 6379
vaild vaule:
大于或等于 1
Redis 节点的端口。当 policy 为 redis 时使用。
redis_username
string
如果使用 Redis ACL，则为 Redis 的用户名。如果你使用传统的认证方法 requirepass，则只需配置 redis_password。当 policy 为 redis 时使用。
redis_password
string
Redis 节点的密码。当 policy 为 redis 或 redis-cluster 时使用。
redis_database
integer
default: 0
vaild vaule:
大于或等于 0
Redis 中的数据库编号。当 policy 为 redis 时使用。
redis_ssl
boolean
default: false
如果为 true，则在 policy 为 redis 时使用 SSL 连接到 Redis。
redis_ssl_verify
boolean
default: false
如果为 true，则在 policy 为 redis 时验证服务器 SSL 证书。
redis_timeout
integer
default: 1000
vaild vaule:
大于或等于 1
Redis 超时时间（毫秒）。当 policy 为 redis 或 redis-cluster 时使用。
redis_keepalive_timeout
integer
default: 10000
vaild vaule:
大于或等于 1000
当 policy 为 redis 或 redis-cluster 时，Redis 的 keepalive 超时时间（毫秒）。
此参数在 APISIX 3.15.0 版本中可用，尚未在 API7 企业版中提供。
redis_keepalive_pool
integer
default: 100
vaild vaule:
大于或等于 1
当 policy 为 redis 或 redis-cluster 时，Redis 的 keepalive 连接池大小。
此参数在 APISIX 3.15.0 版本中可用，尚未在 API7 企业版中提供。
redis_cluster_nodes
array[string]
Redis 集群节点列表，至少包含两个地址。当 policy 为 redis-cluster 时必填。
redis_cluster_name
string
Redis 集群的名称。当 policy 为 redis-cluster 时必填。
redis_cluster_ssl
boolean
default: false
如果为 true，则在 policy 为 redis-cluster 时使用 SSL 连接到 Redis 集群。
redis_cluster_ssl_verify
boolean
default: false
如果为 true，则在 policy 为 redis-cluster 时验证服务器 SSL 证书。

参数​

参数