Skip to main content
Version: 3.11

limit-req

描述#

limit-req 插件使用漏桶算法限制单个客户端对服务的请求速率。

属性#

名称类型必选项默认值有效值描述
rateinteger是rate > 0指定的请求速率（以秒为单位），请求速率超过 rate 但没有超过（rate + burst）的请求会被延时处理。
burstinteger是burst >= 0请求速率超过（rate + burst）的请求会被直接拒绝。
key_typestring否"var"["var", "var_combination"]要使用的用户指定 key 的类型。
keystring是["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name"]用来做请求计数的依据，当前接受的 key 有：remote_addr（客户端 IP 地址），server_addr（服务端 IP 地址）, 请求头中的 X-Forwarded-For 或 X-Real-IP，consumer_name（Consumer 的 username）。
rejected_codeinteger否503[200,...,599]当超过阈值的请求被拒绝时，返回的 HTTP 状态码。
rejected_msgstring否非空当超过阈值的请求被拒绝时，返回的响应体。
nodelayboolean否false当设置为 true 时，请求速率超过 rate 但没有超过（rate + burst）的请求不会加上延迟；当设置为 false，则会加上延迟。
allow_degradationboolean否false当设置为 true 时，如果限速插件功能临时不可用，将会自动允许请求继续。
policystring否"local"["local", "redis", "redis-cluster"]用于检索和增加限制计数的策略。当设置为 local 时，计数器被以内存方式保存在节点本地；当设置为 redis 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 redis-cluster 时，使用 Redis 集群而不是单个实例。
redis_hoststring否当使用 redis 限速策略时，Redis 服务节点的地址。当 policy 属性设置为 redis 时必选。
redis_portinteger否6379[1,...]当使用 redis 限速策略时，Redis 服务节点的端口。
redis_usernamestring否若使用 Redis ACL 进行身份验证（适用于 Redis 版本 >=6.0），则需要提供 Redis 用户名。若使用 Redis legacy 方式 requirepass 进行身份验证，则只需将密码配置在 redis_password。当 policy 设置为 redis 时使用。
redis_passwordstring否当使用 redis 或者 redis-cluster 限速策略时，Redis 服务节点的密码。
redis_sslboolean否false当使用 redis 限速策略时，如果设置为 true，则使用 SSL 连接到 redis
redis_ssl_verifyboolean否false当使用 redis 限速策略时，如果设置为 true，则验证服务器 SSL 证书的有效性，具体请参考 tcpsock:sslhandshake.
redis_databaseinteger否0redis_database >= 0当使用 redis 限速策略时，Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。
redis_timeoutinteger否1000[1,...]当 policy 设置为 redis 或 redis-cluster 时，Redis 服务节点的超时时间（以毫秒为单位）。
redis_cluster_nodesarray否当使用 redis-cluster 限速策略时，Redis 集群服务节点的地址列表（至少需要两个地址）。当 policy 属性设置为 redis-cluster 时必选。
redis_cluster_namestring否当使用 redis-cluster 限速策略时，Redis 集群服务节点的名称。当 policy 设置为 redis-cluster 时必选。
redis_cluster_sslboolean否false当使用 redis-cluster 限速策略时，如果设置为 true，则使用 SSL 连接到 redis-cluster
redis_cluster_ssl_verifyboolean否false当使用 redis-cluster 限速策略时，如果设置为 true，则验证服务器 SSL 证书的有效性

启用插件#

在 Route 或 Service 上启用插件#

以下示例展示了如何在指定路由上启用 limit-req 插件，并设置 key_type 的值为 var：

note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量：

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/index.html",
    "plugins": {
        "limit-req": {
            "rate": 3,
            "burst": 2,
            "rejected_code": 503,
            "key_type": "var",
            "key": "remote_addr"
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

上述示例表示，APISIX 将客户端的 IP 地址作为限制请求速率的条件，当请求速率小于等于 3 次每秒（rate）时，请求正常；当请求速率大于 3 次每秒（rate），小于等于 5 次每秒（rate + burst）时，将会对超出部分的请求进行延迟处理；当请求速率大于 5 次每秒（rate + burst）时，超出规定数量的请求将返回 HTTP 状态码 503。

你也可以设置 key_type 的值为 var_combination：

{
    "methods": ["GET"],
    "uri": "/index.html",
    "plugins": {
        "limit-req": {
            "rate": 3,
            "burst": 2,
            "rejected_code": 503,
            "key_type": "var_combination",
            "key": "$consumer_name $remote_addr"
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:9001": 1
        }
    }
}

测试插件

通过以下命令发送请求：

curl -i http://127.0.0.1:9080/index.html

当请求速率超出限制时，返回如下包含 503 HTTP 状态码的响应头，插件生效：

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: text/html
Content-Length: 194
Connection: keep-alive
Server: APISIX web server

<html>
<head><title>503 Service Temporarily Unavailable</title></head>
<body>
<center><h1>503 Service Temporarily Unavailable</h1></center>
<hr><center>openresty</center>
</body>
</html>

同时，如果你设置了 rejected_msg 属性的值为 "Requests are too frequent, please try again later."，当请求速率超出限制时，返回如下包含 503 HTTP 状态码的响应体：

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: text/html
Content-Length: 194
Connection: keep-alive
Server: APISIX web server

{"error_msg":"Requests are too frequent, please try again later."}

在 Consumer 上启用插件#

在 Consumer 上启用 limit-req 插件需要与认证插件一起配合使用，以 key-auth 授权插件为例。

首先，将 limit-req 插件绑定到 Consumer 上：

curl http://127.0.0.1:9180/apisix/admin/consumers \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "username": "consumer_jack",
    "plugins": {
        "key-auth": {
            "key": "auth-jack"
        },
        "limit-req": {
            "rate": 1,
            "burst": 1,
            "rejected_code": 403,
            "key": "consumer_name"
        }
    }
}'

然后，在指定路由上启用并配置 key-auth 插件：

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/index.html",
    "plugins": {
        "key-auth": {
            "key": "auth-jack"
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

测试插件

通过以下命令发送请求：

curl -i http://127.0.0.1:9080/index.html -H 'apikey: auth-jack'

当请求速率未超过 rate + burst 的值时，返回 200 HTTP 状态码，说明请求成功，插件生效：

HTTP/1.1 200 OK

当请求速率超过 rate + burst 的值时，返回 403 HTTP 状态码，说明请求被阻止，插件生效：

HTTP/1.1 403 Forbidden
...
<html>
<head><title>403 Forbidden</title></head>
<body>
<center><h1>403 Forbidden</h1></center>
<hr><center>openresty</center>
</body>
</html>

删除插件#

当你需要删除该插件时，可以通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/index.html",
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

你也可以通过以下命令移除 Consumer 上的 limit-req 插件：

curl http://127.0.0.1:9180/apisix/admin/consumers -H "X-API-KEY: $admin_key" -X PUT -d '
{
    "username": "consumer_jack",
    "plugins": {
        "key-auth": {
            "key": "auth-jack"
        }
    }
}'