limit-req
key 是可以被用户自定义的,只需要修改插件的一行代码即可完成。并没有在插件中放开是处于安全的考虑。
这里以route
为例(service
的使用是同样的方法),在指定的 route
上启用 limit-req
插件。
你也可以通过 web 界面来完成上面的操作,先增加一个 route,然后在插件页面中添加 limit-req 插件:
测试插件
当你超过,就会收到包含 503 返回码的响应头:
HTTP/1.1 503 Service Temporarily UnavailableContent-Type: text/htmlContent-Length: 194Connection: keep-aliveServer: 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."
,当你超过,就会收到如下的响应体:
这就表示 limit req 插件生效了。
如何在consumer
上使用
consumer上开启插件,需要与授权插件一起配合使用,这里以key-auth授权插件为例。
1、将limit-req
插件绑定到consumer上
curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{ "username": "consumer_jack", "plugins": { "key-auth": { "key": "auth-jack" }, "limit-req": { "rate": 1, "burst": 1, "rejected_code": 403, "key": "consumer_name" } }}'
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{ "methods": ["GET"], "uri": "/index.html", "plugins": { "key-auth": { "key": "auth-jack" } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }}'
测试插件
未超过rate + burst
的值
当超过rate + burst
的值
curl -i http://127.0.0.1:9080/index.html -H 'apikey: auth-jack'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>
说明绑在consumer
上的 limit-req
插件生效了
当你想去掉 limit req 插件的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效:
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{ "methods": ["GET"], "uri": "/index.html", "upstream": { "type": "roundrobin", "nodes": { "39.97.63.215:80": 1 } }}'
现在就已经移除了 limit req 插件了。其他插件的开启和移除也是同样的方法。