limit-req

    这里以route为例 (service的使用是同样的方法)，在指定的 route 上启用 limit-req 插件，并设置 key_type 为 var。

    这里以 route 为例（service 的使用是同样的方法），在指定的 route 上启用 limit-req 插件，并设置 key_type 为 var_combination。

    1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    2. {
    3.     "methods": ["GET"],
    4.     "uri": "/index.html",
    5.     "plugins": {
    6.         "limit-req": {
    7.             "rate": 1,
    8.             "burst": 2,
    9.             "rejected_code": 503,
    11.             "key": "$consumer_name $remote_addr"
    12.         }
    13.     },
    14.     "upstream": {
    15.         "type": "roundrobin",
    16.         "nodes": {
    17.             "127.0.0.1:1980": 1
    18.     }
    19. }'

    你也可以通过 web 界面来完成上面的操作，先增加一个 route，然后在插件页面中添加 limit-req 插件：

    测试插件

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

    当你超过，就会收到包含 503 返回码的响应头：

    同时，如果你设置了属性 rejected_msg 的值为 "Requests are too frequent, please try again later."，当你超过，就会收到如下的响应体：

    1. HTTP/1.1 503 Service Temporarily Unavailable
    2. Content-Type: text/html
    3. Content-Length: 194
    4. Connection: keep-alive
    5. Server: APISIX web server
    7. {"error_msg":"Requests are too frequent, please try again later."}

    这就表示 limit req 插件生效了。

    如何在 consumer上使用

    consumer 上开启 limit-req 插件，需要与授权插件一起配合使用，这里以 key-auth 授权插件为例。

    1、将 limit-req 插件绑定到 consumer 上

    1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    2. {
    3.     "username": "consumer_jack",
    4.     "plugins": {
    5.         "key-auth": {
    6.             "key": "auth-jack"
    7.         },
    8.         "limit-req": {
    9.             "rate": 1,
    10.             "burst": 1,
    12.             "key": "consumer_name"
    13.         }
    14. }'

    测试插件

    未超过 rate + burst 的值

    1. curl -i http://127.0.0.1:9080/index.html -H 'apikey: auth-jack'
    2. HTTP/1.1 200 OK
    3. ......

    当超过 rate + burst 的值

    1. curl -i http://127.0.0.1:9080/index.html -H 'apikey: auth-jack'
    2. HTTP/1.1 403 Forbidden
    3. .....
    4. <html>
    5. <head><title>403 Forbidden</title></head>
    6. <body>
    7. <center><h1>403 Forbidden</h1></center>
    8. <hr><center>openresty</center>
    9. </body>
    10. </html>

    说明绑在 consumer上的 limit-req 插件生效了

    当你想去掉 limit req 插件的时候，很简单，在插件的配置中把对应的 json 配置删除即可，无须重启服务，即刻生效：

    1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    2. {
    3.     "username": "consumer_jack",
    4.     "plugins": {
    5.         "key-auth": {
    6.             "key": "auth-jack"
    7.         }
    8.     }

    现在就已经移除了 limit req 插件了。其他插件的开启和移除也是同样的方法。