模块 ngx_http_limit_req_module

ngx_http_limit_req_module 模块 (0.7.21) 用于限制每个已定义键的请求处理速率，特别是来自单个 IP 地址的请求的处理速率。限制使用“漏桶”方法完成。

http {
    limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

    ...

    server {

        ...

        location /search/ {
            limit_req zone=one burst=5;
        }

设置共享内存区域和请求的最大突发大小。如果请求速率超过为某个区域配置的速率，则会延迟其处理，以便以定义的速率处理请求。过多的请求会延迟，直到其数量超过最大突发大小，在这种情况下，请求将以 错误 终止。默认情况下，最大突发大小等于零。例如，指令

limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

server {
    location /search/ {
        limit_req zone=one burst=5;
    }

允许每秒平均不超过 1 个请求，突发不超过 5 个请求。

如果在限制请求时不希望延迟过多的请求，则应使用参数 nodelay

limit_req zone=one burst=5 nodelay;

delay 参数 (1.15.7) 指定过多的请求开始延迟的限制。默认值为零，即所有过多的请求都会延迟。

可能有多个 limit_req 指令。例如，以下配置将限制来自单个 IP 地址的请求的处理速率，同时限制虚拟服务器的请求处理速率

limit_req_zone $binary_remote_addr zone=perip:10m rate=1r/s;
limit_req_zone $server_name zone=perserver:10m rate=10r/s;

server {
    ...
    limit_req zone=perip burst=5 nodelay;
    limit_req zone=perserver burst=10;
}

当且仅当在当前级别未定义 limit_req 指令时，这些指令才会从之前的配置级别继承。

limit_req_dry_run off;

启用空运行模式。在此模式下，请求处理速率不受限制，但是，在共享内存区域中，超额请求的数量会照常计算。

limit_req_log_level error;

当服务器因速率超限而拒绝处理请求或延迟处理请求时，设置所需的日志记录级别。延迟的日志记录级别比拒绝的日志记录级别低一点；例如，如果指定了“limit_req_log_level notice”，则延迟将以 info 级别记录。

limit_req_status 503;

设置在响应被拒绝的请求时返回的状态代码。

设置共享内存区域的参数，该区域将保留各种键的状态。特别是，该状态存储超额请求的当前数量。key 可以包含文本、变量及其组合。不计算键值为空的请求。

在 1.7.6 版本之前，key 可以恰好包含一个变量。

使用示例

limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

在此处，状态保存在 10 兆字节区域“one”中，并且此区域的平均请求处理速率不能超过每秒 1 个请求。

客户端 IP 地址用作键。请注意，此处使用 $binary_remote_addr 变量，而不是 $remote_addr。对于 IPv4 地址，$binary_remote_addr 变量的大小始终为 4 字节，对于 IPv6 地址，其大小始终为 16 字节。在 32 位平台上，存储的状态始终占用 64 字节，在 64 位平台上，存储的状态始终占用 128 字节。一个兆字节区域可以保留大约 16000 个 64 字节状态或大约 8000 个 128 字节状态。

如果区域存储已用尽，则将删除最近最少使用的状态。如果即使在那之后也不能创建新状态，则将以 error 终止该请求。

速率以每秒请求数 (r/s) 为单位指定。如果希望速率低于每秒一个请求，则以每分钟请求数 (r/m) 为单位指定。例如，每秒半个请求为 30r/m。

sync 参数 (1.15.3) 启用共享内存区域的 同步。

sync 参数是我们 商业订阅 的一部分。

此外，作为我们 商业订阅 的一部分，自 1.17.7 起，可以使用 状态信息 来 获取 或 重置 每个此类共享内存区域的 API。

$limit_req_status

保留限制请求处理速率的结果 (1.17.6)：PASSED、DELAYED、REJECTED、DELAYED_DRY_RUN 或 REJECTED_DRY_RUN