limit-conn

    属性

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

    你也可以设置 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": {
    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.         }
    21.     }
    22. }'

    测试插件

    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

    当你需要禁用该插件时，可以通过以下命令删除相应的 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. }'

    应用场景示例

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

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

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

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

      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>