跳到主要内容
版本：3.2.15.2

API 限流限速

速率限制允许控制发送到 API 后端的请求的速率。这有助于保护后端免受过多流量和高成本的影响。API 请求还可能包括网络爬虫生成的无效数据以及网络攻击，例如 DDoS，限制请求速率也有助于降低这些恶意流量的危害，避免业务宕机。

API7 网关提供速率限制功能，通过限制给定时间段内发送到上游节点的请求数量来保护 API。请求计数在内存中高效完成，具有低延迟和高性能。

速率限制

前提条件​

  1. 安装 API7 企业版。
  2. 在网关组上有一个运行的 API。

对所有服务应用速率限制（不推荐）​

速率限制插件通常不会设置为全局规则，因为 API 通常需要不同的速率限制配额。当同一插件在对象（例如路由）中全局和本地配置时，两个插件实例都会按顺序执行。

限制总请求计数​

本节配置一个具有速率限制的路由，在 60 秒内仅允许 3 个请求。当超出限制时，将向消费者返回 429 状态码。

  1. 从侧边栏选择网关组的 已发布服务，然后点击要修改的服务，例如，版本为 1.0.0 的 httpbin API。
  2. 在已发布的服务下，从侧边栏选择 路由。
  3. 选择你的目标路由，例如，getting-started-anything。
  4. 搜索 limit-count 插件。
  5. 点击 加号 图标 (+)。
  6. 在出现的对话框中，执行以下操作：

  • 将以下配置添加到 JSON 编辑器：

    {
      "count": 3,
      "time_window": 60,
      "key_type": "var",
      "rejected_code": 429,
      "rejected_msg": "Too many requests",
      "policy": "local",
      "allow_degradation": false,
      "show_limit_quota_header": true
    }

  • 点击 启用。

下面是一个交互式演示，它介绍了如何使用 limit-count 插件限制请求数量。跟随演示，你将直观了解如何在 API7 企业版中使用这个功能。

验证​

要进行验证，请向路由发送五个连续的请求：

for i in {1..5}; do curl -i '127.0.0.1:9080/ip';  done

前三个请求将成功，后两个请求将被拒绝，并显示 429 Too Many Requests 状态码：

Date: Fri, 01 Jun 2024 04:43:51 GMT
Content-Type: text/plain; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-RateLimit-Limit: 3
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 0
Server: API7/3.2.13.0

{"error_msg":"Too many requests"}

限制每秒请求速率​

本节配置一个具有速率限制的路由，每秒仅允许 1 个请求。当每秒请求数在 1 到 3 之间时，它们将被延迟/限制。当每秒请求数超过 3 时，将返回 429 状态码。

  1. 从侧边栏选择网关组的 已发布服务，然后点击要修改的服务，例如，版本为 1.0.0 的 httpbin API。
  2. 在已发布的服务下，从侧边栏选择 路由。
  3. 选择你的目标路由，例如，getting-started-anything。
  4. 搜索 limit-req 插件。
  5. 点击 加号 图标 (+)。
  6. 在出现的对话框中，执行以下操作：

  • 将以下配置添加到 JSON 编辑器：

    {
      "rate": 1,
      "burst": 2,
      "rejected_code": 429,
      "key_type": "var",
      "key": "remote_addr",
      "rejected_msg": "Requests are too frequent, please try again later."
    }

  • 点击 启用。

验证​

要进行验证，请向路由发送五个请求：

for i in {1..5}; do curl -i '127.0.0.1:9080/ip';  done

由于请求是按顺序发送的，你会收到所需的响应。现在向路由发送五个并发请求：

curl -i "http://127.0.0.1:9080/ip" & \
curl -i "http://127.0.0.1:9080/ip" & \
curl -i "http://127.0.0.1:9080/ip" & \
curl -i "http://127.0.0.1:9080/ip" & \
curl -i "http://127.0.0.1:9080/ip"

三个请求会返回正常响应，另外两个请求会因为每秒请求数超过限制而被拒绝，返回如下响应：

HTTP/1.1 429 Too Many Requests
Date: Fri, 01 Jun 2024 04:43:51 GMT
Content-Type: text/plain; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Server: API7/3.2.13.0

{"error_msg":"Requests are too frequent, please try again later."}

相关阅读​