对 API 应用限流
限流可控制发送到 API 后端的请求数量,避免正常流量或不需要的流量(如网络爬虫、DDoS 攻击)过多,导致运营效率下降和成本增加。
本指南介绍如何使用限流控制一段时间内发送到上游节点的请求。

前提条件
对所有服务应用限流(不推荐)
不同 API 通常需要不同的限流配额,因此不应在全局配置限流插件。如果在全局规则和单个路由上配置了同一个插件,API7 网关会依次执行这两个插件实例。
对单个路由应用限流
限制请求次数
本节为路由配置限流,使其在 60 秒内只允许 3 个请求。超出限制时,网关会向消费者返回 429 状态码。
- 控制台
- ADC
- Ingress Controller
-
从侧边栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为
1.0.0的httpbin。 -
在已发布服务的侧边栏中选择路由。
-
选择目标路由,例如
get-ip。 -
在插件字段中点击启用插件。
-
搜索 Limit Count 插件,然后点击启用。
-
在对话框中执行以下操作:
- 将以下配置添加到 JSON 编辑器:
{"count": 3,"time_window": 60,"key_type": "var","rejected_code": 429,"rejected_msg": "Too many requests","key": "remote_addr","policy": "local","allow_degradation": false,"show_limit_quota_header": true}- 点击启用。
下方的交互式演示介绍如何限制请求次数。点击并按照演示步骤操作,了解如何在 API7 企业版中使用此功能。
若要使用 ADC 配置路由,请创建以下配置:
services:
- name: httpbin
upstream:
name: default
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
routes:
- uris:
- /ip
name: get-ip
methods:
- GET
plugins:
limit-count:
_meta:
disable: false
allow_degradation: false
count: 3
key: remote_addr
key_type: var
policy: local
rejected_code: 429
rejected_msg: Too many requests
show_limit_quota_header: true
time_window: 60
将配置同步到 API7 企业版:
adc sync -f adc.yaml
创建一个启用了 limit-count 插件的路由 Kubernetes 清单文件:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: httpbin
# namespace: api7 # replace with your namespace
spec:
http:
- name: get-ip
match:
paths:
- /ip
methods:
- GET
backends:
- serviceName: httpbin
servicePort: 80
plugins:
- name: limit-count
enable: true
config:
time_window: 60
count: 3
rejected_code: 429
将配置应用到你的集群:
kubectl apply -f httpbin-route.yaml
验证
连续发送 5 个请求以验证配置:
resp=$(seq 5 | xargs -I{} curl "http://127.0.0.1:9080/ip" -o /dev/null -s -w "%{http_code}\n") && \
count_200=$(echo "$resp" | grep "200" | wc -l) && \
count_429=$(echo "$resp" | grep "429" | wc -l) && \
echo "200": $count_200, "429": $count_429
返回结果应显示 5 个请求中有 3 个成功(状态码 200),其余请求被拒绝(状态码 429)。
200: 3, 429: 2
限制每秒请求数
本节为路由配置限流,使其每秒只允许 1 个请求。当每秒请求数在 1 到 3 之间时,请求会被延迟处理或限速。当每秒请求数超过 3 时,网关会返回 429 状态码。
- 控制台
- ADC
- Ingress Controller
-
从侧边栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为
1.0.0的httpbin。 -
在已发布服务的侧边栏中选择路由。
-
选择目标路由,例如
get-ip。 -
在插件字段中点击启用插件。
-
搜索 Limit Req 插件,然后点击启用。
-
在对话框中执行以下操作:
- 将以下配置添加到 JSON 编辑器:
{"rate": 1,"burst": 2,"rejected_code": 429,"key_type": "var","key": "remote_addr","rejected_msg": "Requests are too frequent, please try again later."}- 点击启用。
若要使用 ADC 配置路由,请创建以下配置:
services:
- name: httpbin
upstream:
name: default
scheme: http
nodes:
- host: httpbin.org
port: 80
weight: 100
routes:
- uris:
- /ip
name: get-ip
methods:
- GET
plugins:
limit-req:
_meta:
disable: false
burst: 2
key: remote_addr
key_type: var
rate: 1
rejected_code: 429
rejected_msg: Requests are too frequent, please try again later.
将配置同步到 API7 网关:
adc sync -f adc.yaml
创建一个启用了 limit-req 插件的路由 Kubernetes 清单文件:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: httpbin
# namespace: api7 # replace with your namespace
spec:
http:
- name: get-ip
match:
paths:
- /ip
methods:
- GET
backends:
- serviceName: httpbin
servicePort: 80
plugins:
- name: limit-req
enable: true
config:
burst: 2
key: remote_addr
key_type: var
rate: 1
rejected_code: 429
rejected_msg: Requests are too frequent, please try again later.
将配置应用到你的集群:
kubectl apply -f httpbin-route.yaml
验证
向路由发送 5 个请求以验证配置:
for i in {1..5}; do curl -i '127.0.0.1:9080/ip'; done
由于请求是依次发送的,你会收到预期的响应。现在向该路由并发发送 5 个请求:
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"
其中 3 个请求会收到预期的响应,另外 2 个请求会被拒绝并收到以下响应:
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."}
按消费者限流
以下示例演示如何为不同消费者配置不同的限流策略。示例使用 Key Auth 插件 进行身份验证,你也可以为路由配置 Basic Auth 插件、JWT Auth 插件 或 HMAC Auth 插件。
新增消费者
创建具有密钥认证凭据的普通消费者 Alice,然后配置 Limit Count 插件,使其在 60 秒内最多可以发送 3 个请求:
- 控制台
- ADC
- Ingress Controller
-
从侧边栏选择网关组的消费者。
-
点击新增消费者。
-
在对话框中执行以下操作:
- 在名称字段中输入
Alice。 - 点击新增。
- 在名称字段中输入
-
在凭据选项卡下,点击新增 Key Authentication 凭据。
-
在对话框中执行以下操作:
- 在名称字段中输入
primary-key。 - 在密钥字段中选择手动输入,然后输入
alice-primary-key。 - 点击新增。
- 在名称字段中输入
-
打开插件选项卡,点击启用插件。
-
搜索 Limit Req 插件,然后点击启用。
-
在对话框中执行以下操作:
- 将以下配置添加到 JSON 编辑器:
{"count": 3,"time_window": 60,"key_type": "var","rejected_code": 429,"rejected_msg": "Too many requests","key": "remote_addr","policy": "local","allow_degradation": false,"show_limit_quota_header": true}- 点击启用。
即将推出。
创建 Kubernetes 清单文件,使用 ApisixConsumer 自定义资源配置消费者 alice:
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
name: alice
namespace: api7 # replace with your namespace
spec:
authParameter:
keyAuth:
value:
key: "alice-key"
Ingress Controller 目前不支持 ApisixService 资源。
若要在路由上配置 limit-req 插件,请按以下内容更新该路由的 Kubernetes 清单文件:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: httpbin
# namespace: api7 # replace with your namespace
spec:
http:
- name: get-ip
match:
paths:
- /ip
methods:
- GET
backends:
- serviceName: httpbin
servicePort: 80
plugins:
- name: limit-req
enable: true
config:
time_window: 60
count: 3
key_type: var
rejected_code: 429
rejected_msg: Too many requests
key: remote_addr
policy: local
allow_degradation: false
show_limit_quota_header: true
将配置应用到你的集群:
kubectl apply -f consumer.yaml -f httpbin-route.yaml
配置路由
创建路由并配置 Key Auth 插件 进行身份验证:
- 控制台
- ADC
- Ingress Controller
-
从侧边栏选择网关组的已发布服务,然后选择要修改的服务,例如版本为
1.0.0的httpbin。 -
在已发布服务的侧边栏中选择路由。
-
选择目标路由,例如
get-ip。 -
在插件字段中点击启用插件。
-
搜索 Key Auth 插件,然后点击启用。
-
在对话框中执行以下操作:
- 将以下配置添加到 JSON 编辑器:
{}- 点击启用。
即将推出。
按以下内容更新路由的 Kubernetes 清单文件:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: httpbin
# namespace: api7 # replace with your namespace
spec:
http:
- name: get-ip
match:
paths:
- /ip
methods:
- GET
backends:
- serviceName: httpbin
servicePort: 80
plugins:
- name: limit-req
enable: true
config:
time_window: 60
count: 3
key_type: var
rejected_code: 429
rejected_msg: Too many requests
key: remote_addr
policy: local
allow_degradation: false
show_limit_quota_header: true
- name: key-auth
enable: true
将配置应用到你的集群:
kubectl apply -f httpbin-route.yaml
验证
使用 Alice 的密钥连续发送 5 个请求以验证配置:
resp=$(seq 5 | xargs -I{} curl "http://127.0.0.1:9080/ip" -H 'apikey: alice-key' -o /dev/null -s -w "%{http_code}\n") && \
count_200=$(echo "$resp" | grep "200" | wc -l) && \
count_429=$(echo "$resp" | grep "429" | wc -l) && \
echo "200": $count_200, "429": $count_429
返回结果应显示 5 个请求中有 3 个成功(状态码 200),其余请求被拒绝(状态码 429)。
200: 3, 429: 2