limit-conn

描述

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

属性

名称类型必选项默认值有效值描述
conninteger是conn > 0允许的最大并发请求数。超过 conn 的限制、但是低于 conn + burst 的请求，将被延迟处理。
burstinteger是burst >= 0每秒允许被延迟处理的额外并发请求数。
default_conn_delaynumber是default_conn_delay > 0默认的典型连接（或请求）的处理延迟时间。
only_use_default_delayboolean否false[true,false]延迟时间的严格模式。当设置为 true 时，将会严格按照设置的 default_conn_delay 时间来进行延迟处理。
key_typestring否“var”[“var”, “var_combination”]key 的类型。
keystring是用来做请求计数的依据。如果 key_type 为 “var”，那么 key 会被当作变量名称，如 remote_addr 和 consumer_name；如果 key_type 为 “var_combination”，那么 key 会当作变量组合，如 $remote_addr $consumer_name；如果 key 的值为空，$remote_addr 会被作为默认 key。
rejected_codestring否503[200,…,599]当请求数超过 conn + burst 阈值时，返回的 HTTP 状态码。
rejected_msgstring否非空当请求数超过 conn + burst 阈值时，返回的信息。
allow_degradationboolean否false当设置为 true 时，启用插件降级并自动允许请求继续。

启用插件

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

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "methods": ["GET"],
  5.     "uri": "/index.html",
  6.     "id": 1,
  7.     "plugins": {
  8.         "limit-conn": {
  9.             "conn": 1,
  10.             "burst": 0,
  11.             "default_conn_delay": 0.1,
  12.             "rejected_code": 503,
  13.             "key_type": "var",
  14.             "key": "remote_addr"
  15.         }
  16.     },
  17.     "upstream": {
  18.         "type": "roundrobin",
  19.         "nodes": {
  20.             "127.0.0.1:1980": 1
  21.         }
  22.     }
  23. }'

你也可以设置 key_type 为 "var_combination"：

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "methods": ["GET"],
  5.     "uri": "/index.html",
  6.     "id": 1,
  7.     "plugins": {
  8.         "limit-conn": {
  9.             "conn": 1,
  10.             "burst": 0,
  11.             "default_conn_delay": 0.1,
  12.             "rejected_code": 503,
  13.             "key_type": "var_combination",
  14.             "key": "$consumer_name $remote_addr"
  15.         }
  16.     },
  17.     "upstream": {
  18.         "type": "roundrobin",
  19.         "nodes": {
  20.             "127.0.0.1:1980": 1
  21.         }
  22.     }
  23. }'

测试插件

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

  1. curl -i http://127.0.0.1:9080/index.html?sleep=20 &
  3. curl -i http://127.0.0.1:9080/index.html?sleep=20
  1. <html>
  2. <head><title>503 Service Temporarily Unavailable</title></head>
  3. <body>
  4. <center><h1>503 Service Temporarily Unavailable</h1></center>
  5. <hr><center>openresty</center>
  6. </body>
  7. </html>

禁用插件

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

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "methods": ["GET"],
  5.     "uri": "/index.html",
  6.     "upstream": {
  7.         "type": "roundrobin",
  8.         "nodes": {
  9.             "127.0.0.1:1980": 1
  10.         }
  11.     }
  12. }'

应用场景示例

限制 WebSocket 连接的并发数

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

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

    1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
    2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    3. {
    4.     "uri": "/ws",
    5.     "enable_websocket": true,
    6.     "plugins": {
    7.         "limit-conn": {
    8.             "conn": 1,
    9.             "burst": 0,
    10.             "default_conn_delay": 0.1,
    11.             "rejected_code": 503,
    12.             "key_type": "var",
    13.             "key": "remote_addr"
    14.         }
    15.     },
    16.     "upstream": {
    17.         "type": "roundrobin",
    18.         "nodes": {
    19.             "127.0.0.1:1980": 1
    20.         }
    21.     }
    22. }'

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

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

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

    1. curl --include \
    2.     --no-buffer \
    3.     --header "Connection: Upgrade" \
    4.     --header "Upgrade: websocket" \
    5.     --header "Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==" \
    6.     --header "Sec-WebSocket-Version: 13" \
    7.     --http1.1 \
    8.     http://127.0.0.1:9080/ws
    1. HTTP/1.1 101 Switching Protocols

  3. 在另一个终端中再次发起 WebSocket 请求，返回 503 HTTP 状态码表示请求将被拒绝。

    1. HTTP/1.1 503 Service Temporarily Unavailable
    2. ···
    3. <html>
    4. <head><title>503 Service Temporarily Unavailable</title></head>
    5. <body>
    6. <center><h1>503 Service Temporarily Unavailable</h1></center>
    7. <hr><center>openresty</center>
    8. </body>
    9. </html>