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","key": "remote_addr","rejected_code": 429,"rejected_msg": "Too many requests","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
count: 3
time_window: 60
key_type: var
key: remote_addr
policy: local
rejected_code: 429
rejected_msg: Too many requests
allow_degradation: false
show_limit_quota_header: true
将配置同步到 API7 企业版:
adc sync -f adc.yaml
创建 Kubernetes 清单文件,为路由启用限流:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: get-ip
# 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:
count: 3
time_window: 60
key_type: var
key: remote_addr
policy: local
rejected_code: 429
rejected_msg: Too many requests
allow_degradation: false
show_limit_quota_header: true
将配置应用到集群:
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,"key_type": "var","key": "remote_addr","rejected_code": 429,"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
rate: 1
burst: 2
key_type: var
key: remote_addr
rejected_code: 429
rejected_msg: Requests are too frequent, please try again later.
将配置同步到 API7 网关:
adc sync -f adc.yaml
创建 Kubernetes 清单文件,为路由启用限流:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: get-ip
# 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:
rate: 1
burst: 2
key_type: var
key: remote_addr
rejected_code: 429
rejected_msg: Requests are too frequent, please try again later.
将配置应用到集群:
kubectl apply -f httpbin-route.yaml
验证
向路由发送 3 个请求进行验证:
resp=$(seq 3 | xargs -I{} curl -i "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 responses: $count_200 ; 429 responses: $count_429"
通常这 3 个请求都会成功:
200 responses: 3 ; 429 responses: 0
将插件配置中的 burst 改为 0,然后再向路由发送 3 个请求:
resp=$(seq 3 | xargs -I{} curl -i "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 responses: $count_200 ; 429 responses: $count_429"
你会看到类似以下结果,超过速率限制的请求被拒绝:
200 responses: 1 ; 429 responses: 2
按消费者限流
以下示例展示如何为不同消费者配置不同的限流策略。示例使用 Key Auth 插件进行身份验证。路由也可以配置 Basic Auth 插件、JWT Auth 插件或 HMAC Auth 插件。
新增消费者
创建普通消费者 Alice,配置密钥认证凭证,然后配置 limit-count 插件,允许 60 秒内发送 3 个请求:
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的 消费者。
- 点击 新增消费者。
- 在对话框中执行以下操作:
- 在 名称字段中输入
Alice。 - 点击 新增。
- 在 插件字段中点击 启用插件。
- 搜索 Key Auth 插件,然后点击 启用。
- 在对话框中执行以下操作:
-
将以下配置添加到 JSON 编辑器:
{"key": "alice-key"} -
点击 启用。
- 搜索 limit-count 插件,然后点击 启用。
- 在对话框中执行以下操作:
-
将以下配置添加到 JSON 编辑器:
{"count": 3,"time_window": 60,"key_type": "var","key": "remote_addr","rejected_code": 429,"rejected_msg": "Too many requests","policy": "local","allow_degradation": false,"show_limit_quota_header": true} -
点击 启用。
要使用 ADC 创建消费者,请创建以下配置:
consumers:
- username: Alice
plugins:
key-auth:
_meta:
disable: false
key: alice-key
limit-count:
_meta:
disable: false
count: 3
time_window: 60
key_type: var
key: remote_addr
rejected_code: 429
rejected_msg: Too many requests
policy: local
allow_degradation: false
show_limit_quota_header: true
将配置同步到 API7 网关:
adc sync -f adc-consumer.yaml
创建 Kubernetes 清单文件,使用 ApisixConsumer 自定义资源配置消费者:
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
name: alice
# namespace: api7 # replace with your namespace
spec:
authParameter:
keyAuth:
value:
key: "alice-key"
将配置应用到集群:
kubectl apply -f consumer.yaml
配置路由
创建路由并配置 Key Auth 插件进行身份验证:
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的 已发布服务,然后选择要修改的服务,例如版本为
1.0.0的httpbin。 - 在已发布服务下,从侧边栏选择 路由。
- 选择目标路由,例如
get-ip。 - 在 插件字段中点击 启用插件。
- 搜索 Key Auth 插件,然后点击 启用。
- 在对话框中执行以下操作:
-
将以下配置添加到 JSON 编辑器:
{} -
点击 启用。
要使用 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:
key-auth:
_meta:
disable: false
将配置同步到 API7 网关:
adc sync -f adc.yaml
创建 Kubernetes 清单文件,配置启用了限流的路由:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: get-ip
# namespace: api7 # replace with your namespace
spec:
http:
- name: get-ip
match:
paths:
- /ip
methods:
- GET
backends:
- serviceName: httpbin
servicePort: 80
plugins:
- 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