limit-req

描述

限制请求速度的插件,使用的是漏桶算法。

属性

名称类型必选项默认值有效值描述
rateinteger必须rate > 0指定的请求速率(以秒为单位),请求速率超过 rate 但没有超过 (rate + burst)的请求会被加上延时。
burstinteger必须burst >= 0t请求速率超过 (rate + burst)的请求会被直接拒绝。
keystring必须[“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_codeinteger可选503[200,…,599]当请求超过阈值被拒绝时,返回的 HTTP 状态码。
rejected_msgstring可选非空当请求超过阈值被拒绝时,返回的响应体。
nodelayboolean可选false如果 nodelay 为 true, 请求速率超过 rate 但没有超过 (rate + burst)的请求不会加上延迟, 如果是 false,则会加上延迟。
allow_degradationboolean可选false当限速插件功能临时不可用时是否允许请求继续。当值设置为 true 时则自动允许请求继续,默认值是 false。

示例

如何在routeservice上使用

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

  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,
  10. "key_type": "var",
  11. "key": "remote_addr"
  12. }
  13. },
  14. "upstream": {
  15. "type": "roundrobin",
  16. "nodes": {
  17. "127.0.0.1:1980": 1
  18. }
  19. }
  20. }'

这里以 route 为例(service 的使用是同样的方法),在指定的 route 上启用 limit-req 插件,并设置 key_typevar_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,
  10. "key_type": "var_combination",
  11. "key": "$consumer_name $remote_addr"
  12. }
  13. },
  14. "upstream": {
  15. "type": "roundrobin",
  16. "nodes": {
  17. "127.0.0.1:1980": 1
  18. }
  19. }
  20. }'

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

添加插件

测试插件

上述配置限制了每秒请求速率为 1,大于 1 小于 3 的会被加上延时,速率超过 3 就会被拒绝:

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

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

  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
  6. <html>
  7. <head><title>503 Service Temporarily Unavailable</title></head>
  8. <body>
  9. <center><h1>503 Service Temporarily Unavailable</h1></center>
  10. <hr><center>openresty</center>
  11. </body>
  12. </html>

同时,如果你设置了属性 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
  6. {"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,
  11. "rejected_code": 403,
  12. "key": "consumer_name"
  13. }
  14. }
  15. }'

2、创建 route 并开启 key-auth 插件

  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. "key-auth": {
  7. "key": "auth-jack"
  8. }
  9. },
  10. "upstream": {
  11. "type": "roundrobin",
  12. "nodes": {
  13. "127.0.0.1:1980": 1
  14. }
  15. }
  16. }'

测试插件

未超过 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/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "methods": ["GET"],
  4. "uri": "/index.html",
  5. "upstream": {
  6. "type": "roundrobin",
  7. "nodes": {
  8. "127.0.0.1:1980": 1
  9. }
  10. }
  11. }'

移除 consumer上的 limit-req 插件

  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. }
  9. }'

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