Skip to main content
Version: Next

limit-conn

描述#

limit-conn 插件用于限制客户端对单个服务的并发请求数。当客户端对路由的并发请求数达到限制时,可以返回自定义的状态码和响应信息。

属性#

名称类型必选项默认值有效值描述
connintegerconn > 0允许的最大并发请求数。超过 conn 的限制、但是低于 conn + burst 的请求,将被延迟处理。
burstintegerburst >= 0每秒允许被延迟处理的额外并发请求数。
default_conn_delaynumberdefault_conn_delay > 0默认的典型连接(或请求)的处理延迟时间。
only_use_default_delaybooleanfalse[true,false]延迟时间的严格模式。当设置为 true 时,将会严格按照设置的 default_conn_delay 时间来进行延迟处理。
key_typestring"var"["var", "var_combination"]key 的类型。
keystring用来做请求计数的依据。如果 key_type"var",那么 key 会被当作变量名称,如 remote_addrconsumer_name;如果 key_type"var_combination",那么 key 会当作变量组合,如 $remote_addr $consumer_name;如果 key 的值为空,$remote_addr 会被作为默认 key
rejected_codestring503[200,...,599]当请求数超过 conn + burst 阈值时,返回的 HTTP 状态码。
rejected_msgstring非空当请求数超过 conn + burst 阈值时,返回的信息。
allow_degradationbooleanfalse当设置为 true 时,启用插件降级并自动允许请求继续。
policystring"local"["local", "redis", "redis-cluster"]用于检索和增加限制计数的策略。当设置为 local 时,计数器被以内存方式保存在节点本地;当设置为 redis 时,计数器保存在 Redis 服务节点上,从而可以跨节点共享结果,通常用它来完成全局限速;当设置为 redis-cluster 时,使用 Redis 集群而不是单个实例。
redis_hoststring当使用 redis 限速策略时,Redis 服务节点的地址。policy 属性设置为 redis 时必选。
redis_portinteger6379[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_sslbooleanfalse当使用 redis 限速策略时,如果设置为 true,则使用 SSL 连接到 redis
redis_ssl_verifybooleanfalse当使用 redis 限速策略时,如果设置为 true,则验证服务器 SSL 证书的有效性,具体请参考 tcpsock:sslhandshake.
redis_databaseinteger0redis_database >= 0当使用 redis 限速策略时,Redis 服务节点中使用的 database,并且只针对非 Redis 集群模式(单实例模式或者提供单入口的 Redis 公有云服务)生效。
redis_timeoutinteger1000[1,...]policy 设置为 redisredis-cluster 时,Redis 服务节点的超时时间(以毫秒为单位)。
redis_cluster_nodesarray当使用 redis-cluster 限速策略时,Redis 集群服务节点的地址列表(至少需要两个地址)。policy 属性设置为 redis-cluster 时必选。
redis_cluster_namestring当使用 redis-cluster 限速策略时,Redis 集群服务节点的名称。policy 设置为 redis-cluster 时必选。
redis_cluster_sslbooleanfalse当使用 redis-cluster 限速策略时,如果设置为 true,则使用 SSL 连接到 redis-cluster
redis_cluster_ssl_verifybooleanfalse当使用 redis-cluster 限速策略时,如果设置为 true,则验证服务器 SSL 证书的有效性

启用插件#

以下示例展示了如何在指定路由上启用 limit-conn 插件,并设置 key_type"var"

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uri": "/index.html",
"id": 1,
"plugins": {
"limit-conn": {
"conn": 1,
"burst": 0,
"default_conn_delay": 0.1,
"rejected_code": 503,
"key_type": "var",
"key": "remote_addr"
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'

你也可以设置 key_type"var_combination"

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uri": "/index.html",
"id": 1,
"plugins": {
"limit-conn": {
"conn": 1,
"burst": 0,
"default_conn_delay": 0.1,
"rejected_code": 503,
"key_type": "var_combination",
"key": "$consumer_name $remote_addr"
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'

测试插件#

按上述配置启用插件后,在这条路由资源上,APISIX 将只允许一个连接;当有更多连接进入时,APISIX 会直接返回 503 HTTP 状态码,拒绝连接。

curl -i http://127.0.0.1:9080/index.html?sleep=20 &

curl -i http://127.0.0.1:9080/index.html?sleep=20
<html>
<head><title>503 Service Temporarily Unavailable</title></head>
<body>
<center><h1>503 Service Temporarily Unavailable</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: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uri": "/index.html",
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'

应用场景示例#

限制 WebSocket 连接的并发数#

Apache APISIX 支持 WebSocket 代理,我们可以使用 limit-conn 插件限制 WebSocket 连接的并发数。

  1. 创建路由并启用 WebSocket 代理和 limit-conn 插件。

    curl http://127.0.0.1:9180/apisix/admin/routes/1 \
    -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    {
    "uri": "/ws",
    "enable_websocket": true,
    "plugins": {
    "limit-conn": {
    "conn": 1,
    "burst": 0,
    "default_conn_delay": 0.1,
    "rejected_code": 503,
    "key_type": "var",
    "key": "remote_addr"
    }
    },
    "upstream": {
    "type": "roundrobin",
    "nodes": {
    "127.0.0.1:1980": 1
    }
    }
    }'

    上述路由在 /ws 上开启了 WebSocket 代理,并限制了 WebSocket 连接并发数为 1

    当 WebSocket 连接并发数超过 1 时,APISIX 将会拒绝请求,并返回 HTTP 状态码 503

  2. 发起 WebSocket 请求,返回 101 HTTP 状态码表示连接建立成功。

    curl --include \
    --no-buffer \
    --header "Connection: Upgrade" \
    --header "Upgrade: websocket" \
    --header "Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==" \
    --header "Sec-WebSocket-Version: 13" \
    --http1.1 \
    http://127.0.0.1:9080/ws
    HTTP/1.1 101 Switching Protocols
  3. 在另一个终端中再次发起 WebSocket 请求,返回 503 HTTP 状态码表示请求将被拒绝。

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