limit-count

目录

简介

和 GitHub API 的限速类似， 在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。

参数

名称类型必选项默认值有效值描述
countinteger必须count > 0指定时间窗口内的请求数量阈值
time_windowinteger必须time_window > 0时间窗口的大小（以秒为单位），超过这个时间就会重置
keystring可选“remote_addr”[“remote_addr”, “server_addr”, “http_x_real_ip”, “http_x_forwarded_for”, “consumer_name”, “service_id”]用来做请求计数的有效值。
例如，可以使用主机名（或服务器区域）作为关键字，以便限制每个主机名规定时间内的请求次数。我们也可以使用客户端地址作为关键字，这样我们就可以避免单个客户端规定时间内多次的连接我们的服务。
当前接受的 key 有：”remote_addr”（客户端 IP 地址）, “server_addr”（服务端 IP 地址）, 请求头中的”X-Forwarded-For” 或 “X-Real-IP”, “consumer_name”（consumer 的 username）, “service_id” 。
rejected_codeinteger可选503[200,…,599]当请求超过阈值被拒绝时，返回的 HTTP 状态码
rejected_msgstring可选非空当请求超过阈值被拒绝时，返回的响应体。
policystring可选“local”[“local”, “redis”, “redis-cluster”]用于检索和增加限制的速率限制策略。可选的值有：local(计数器被以内存方式保存在节点本地，默认选项) 和 redis(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及redis-cluster，跟 redis 功能一样，只是使用 redis 集群方式。
allow_degradationboolean可选false当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。
show_limit_quota_headerboolean可选true是否在响应头中显示 X-RateLimit-Limit 和 X-RateLimit-Remaining （限制的总请求数和剩余还可以发送的请求数），默认值是 true。
redis_hoststringredis 必须当使用 redis 限速策略时，该属性是 Redis 服务节点的地址。
redis_portinteger可选6379[1,…]当使用 redis 限速策略时，该属性是 Redis 服务节点的端口
redis_passwordstring可选当使用 redis 或者 redis-cluster 限速策略时，该属性是 Redis 服务节点的密码。
redis_databaseinteger可选0redis_database >= 0当使用 redis 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。
redis_timeoutinteger可选1000[1,…]当使用 redis 或者 redis-cluster 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间
redis_cluster_nodesarray当 policy 为 redis-cluster 时必填当使用 redis-cluster 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。
redis_cluster_namestring当 policy 为 redis-cluster 时必填当使用 redis-cluster 限速策略时，该属性是 Redis 集群服务节点的名称。

key 是可以被用户自定义的，只需要修改插件的一行代码即可完成。并没有在插件中放开是处于安全的考虑。

如何使用

开启插件

下面是一个示例，在指定的 route 上开启了 limit count 插件:

  1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "plugins": {
  5.         "limit-count": {
  6.             "count": 2,
  7.             "time_window": 60,
  8.             "rejected_code": 503,
  9.             "key": "remote_addr"
  10.         }
  11.     },
  12.     "upstream": {
  13.         "type": "roundrobin",
  14.         "nodes": {
  15.             "39.97.63.215:80": 1
  16.         }
  17.     }
  18. }'

你可以使用浏览器打开 dashboard：http://127.0.0.1:9080/apisix/dashboard/，通过 web 界面来完成上面的操作，先增加一个 route： 添加路由

然后在 route 页面中添加 limit-count 插件： 添加插件

如果你需要一个集群级别的流量控制，我们可以借助 redis server 来完成。不同的 APISIX 节点之间将共享流量限速结果，实现集群流量限速。

如果启用单 redis 策略，请看下面例子：

  1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "plugins": {
  5.         "limit-count": {
  6.             "count": 2,
  7.             "time_window": 60,
  8.             "rejected_code": 503,
  9.             "key": "remote_addr",
  10.             "policy": "redis",
  11.             "redis_host": "127.0.0.1",
  12.             "redis_port": 6379,
  13.             "redis_password": "password",
  14.             "redis_database": 1,
  15.             "redis_timeout": 1001
  16.         }
  17.     },
  18.     "upstream": {
  19.         "type": "roundrobin",
  20.         "nodes": {
  21.             "39.97.63.215:80": 1
  22.         }
  23.     }
  24. }'

如果使用 redis-cluster 策略:

  1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "plugins": {
  5.         "limit-count": {
  6.             "count": 2,
  7.             "time_window": 60,
  8.             "rejected_code": 503,
  9.             "key": "remote_addr",
  10.             "policy": "redis-cluster",
  11.             "redis_cluster_nodes": [
  12.                 "127.0.0.1:5000",
  13.                 "127.0.0.1:5001"
  14.             ],
  15.             "redis_password": "password",
  16.             "redis_cluster_name": "redis-cluster-1"
  17.         }
  18.     },
  19.     "upstream": {
  20.         "type": "roundrobin",
  21.         "nodes": {
  22.             "39.97.63.215:80": 1
  23.         }
  24.     }
  25. }'

测试插件

上述配置限制了 60 秒内只能访问 2 次，前两次访问都会正常访问：

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

响应头里面包含了 X-RateLimit-Limit 和 X-RateLimit-Remaining，他们的含义分别是限制的总请求数和剩余还可以发送的请求数：

  1. HTTP/1.1 200 OK
  2. Content-Type: text/html
  3. Content-Length: 13175
  4. Connection: keep-alive
  5. X-RateLimit-Limit: 2
  6. X-RateLimit-Remaining: 0
  7. Server: APISIX web server

当你第三次访问的时候，就会收到包含 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
  8. <html>
  9. <head><title>503 Service Temporarily Unavailable</title></head>
  10. <body>
  11. <center><h1>503 Service Temporarily Unavailable</h1></center>
  12. <hr><center>openresty</center>
  13. </body>
  14. </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
  8. {"error_msg":"Requests are too frequent, please try again later."}

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

移除插件

当你想去掉 limit count 插件的时候，很简单，在插件的配置中把对应的 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.             "39.97.63.215:80": 1
  9.         }
  10.     }
  11. }'

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