limit-req
#
目录#
简介限制请求速度的插件,使用的是漏桶算法。
#
属性名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
---|---|---|---|---|---|
rate | integer | 必须 | rate > 0 | 指定的请求速率(以秒为单位),请求速率超过 rate 但没有超过 (rate + burst )的请求会被加上延时。 | |
burst | integer | 必须 | burst >= 0 | t请求速率超过 (rate + burst )的请求会被直接拒绝。 | |
key | string | 必须 | ["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name"] | 用来做请求计数的依据,当前接受的 key 有:"remote_addr"(客户端IP地址), "server_addr"(服务端 IP 地址), 请求头中的"X-Forwarded-For" 或 "X-Real-IP","consumer_name"(consumer 的 username)。 | |
rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时,返回的 HTTP 状态码。 |
rejected_msg | string | 可选 | 非空 | 当请求超过阈值被拒绝时,返回的响应体。 | |
nodelay | boolean | 可选 | false | 如果 nodelay 为 true, 请求速率超过 rate 但没有超过 (rate + burst )的请求不会加上延迟, 如果是 false,则会加上延迟。 | |
allow_degradation | boolean | 可选 | false | 当限速插件功能临时不可用时是否允许请求继续。当值设置为 true 时则自动允许请求继续,默认值是 false。 |
key 是可以被用户自定义的,只需要修改插件的一行代码即可完成。并没有在插件中放开是处于安全的考虑。
#
示例route
或service
上使用#
如何在这里以route
为例(service
的使用是同样的方法),在指定的 route
上启用 limit-req
插件。
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": { "limit-req": { "rate": 1, "burst": 2, "rejected_code": 503, "key": "remote_addr" } }, "upstream": { "type": "roundrobin", "nodes": { "39.97.63.215:80": 1 } }}'
你也可以通过 web 界面来完成上面的操作,先增加一个 route,然后在插件页面中添加 limit-req 插件:
测试插件
上述配置限制了每秒请求速率为 1,大于 1 小于 3 的会被加上延时,速率超过 3 就会被拒绝:
curl -i http://127.0.0.1:9080/index.html
当你超过,就会收到包含 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."
,当你超过,就会收到如下的响应体:
HTTP/1.1 503 Service Temporarily UnavailableContent-Type: text/htmlContent-Length: 194Connection: keep-aliveServer: APISIX web server
{"error_msg":"Requests are too frequent, please try again later."}
这就表示 limit req 插件生效了。
consumer
上使用#
如何在consumer上开启limit-req
插件,需要与授权插件一起配合使用,这里以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" } }}'
2、创建route
并开启key-auth
插件
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
的值
curl -i http://127.0.0.1:9080/index.html -H 'apikey: auth-jack'HTTP/1.1 200 OK......
当超过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 } }}'
移除consumer
上的 limit-req
插件
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 插件了。其他插件的开启和移除也是同样的方法。