功能说明

ai-token-ratelimit插件实现了基于特定键值实现token限流，键值来源可以是 URL 参数、HTTP 请求头、客户端 IP 地址、consumer 名称、cookie中 key 名称

注意

此插件功能生效，需要同时开启AI 可观测插件，实现 token 数的统计

运行属性

插件执行阶段：默认阶段 插件执行优先级：600

配置说明

配置项类型必填默认值说明
rule_namestring是-限流规则名称，根据限流规则名称+限流类型+限流key名称+限流key对应的实际值来拼装redis key
rule_itemsarray of object是-限流规则项，按照rule_items下的排列顺序，匹配第一个rule_item后命中限流规则，后续规则将被忽略
rejected_codeint否429请求被限流时，返回的HTTP状态码
rejected_msgstring否Too many requests请求被限流时，返回的响应体
redisobject是-redis相关配置

rule_items中每一项的配置字段说明

配置项类型必填默认值说明
limitby_headerstring否，limit_by中选填一项-配置获取限流键值的来源 HTTP 请求头名称
limitby_paramstring否，limit_by中选填一项-配置获取限流键值的来源 URL 参数名称
limitby_consumerstring否，limit_by中选填一项-根据 consumer 名称进行限流，无需添加实际值
limitby_cookiestring否，limit_by中选填一项-配置获取限流键值的来源 Cookie中 key 名称
limitby_per_headerstring否，limit_by中选填一项-按规则匹配特定 HTTP 请求头，并对每个请求头分别计算限流，配置获取限流键值的来源 HTTP 请求头名称，配置limit_keys时支持正则表达式或
limitby_per_paramstring否，limit_by中选填一项-按规则匹配特定 URL 参数，并对每个参数分别计算限流，配置获取限流键值的来源 URL 参数名称，配置limit_keys时支持正则表达式或
limitby_per_consumerstring否，limit_by中选填一项-按规则匹配特定 consumer，并对每个 consumer 分别计算限流，根据 consumer 名称进行限流，无需添加实际值，配置limit_keys时支持正则表达式或
limitby_per_cookiestring否，limit_by中选填一项-按规则匹配特定 Cookie，并对每个 Cookie 分别计算限流，配置获取限流键值的来源 Cookie中 key 名称，配置limit_keys时支持正则表达式或
limitby_per_ipstring否，limit_by*中选填一项-按规则匹配特定 IP，并对每个 IP 分别计算限流，配置获取限流键值的来源 IP 参数名称，从请求头获取，以from-header-对应的header名，示例：from-header-x-forwarded-for，直接获取对端socket ip，配置为from-remote-addr
limit_keysarray of object是-配置匹配键值后的限流次数

limit_keys中每一项的配置字段说明

配置项类型必填默认值说明
keystring是-匹配的键值，limit_by_per_header,limit_by_per_param,limit_by_per_consumer,limit_by_per_cookie 类型支持配置正则表达式（以regexp:开头后面跟正则表达式）或者（代表所有），正则表达式示例：regexp:^d.（以d开头的所有字符串）；limit_by_per_ip支持配置 IP 地址或 IP 段
token_per_secondint否，token_per_second,token_per_minute,token_per_hour,token_per_day 中选填一项-允许每秒请求token数
token_per_minuteint否，token_per_second,token_per_minute,token_per_hour,token_per_day 中选填一项-允许每分钟请求token数
token_per_hourint否，token_per_second,token_per_minute,token_per_hour,token_per_day 中选填一项-允许每小时请求token数
token_per_dayint否，token_per_second,token_per_minute,token_per_hour,token_per_day 中选填一项-允许每天请求token数

redis中每一项的配置字段说明

配置项类型必填默认值说明
service_namestring必填-redis 服务名称，带服务类型的完整 FQDN 名称，例如 my-redis.dns、redis.my-ns.svc.cluster.local
service_portint否服务类型为固定地址（static service）默认值为80，其他为6379输入redis服务的服务端口
usernamestring否-redis用户名
passwordstring否-redis密码
timeoutint否1000redis连接超时时间，单位毫秒

配置示例

识别请求参数 apikey，进行区别限流

  1. rule_name: default_rule
  2. rule_items:
  3.   - limit_by_param: apikey
  4.     limit_keys:
  5.       - key: 9a342114-ba8a-11ec-b1bf-00163e1250b5
  6.         token_per_minute: 10
  7.       - key: a6a6d7f2-ba8a-11ec-bec2-00163e1250b5
  8.         token_per_hour: 100
  9.   - limit_by_per_param: apikey
  10.     limit_keys:
  11.       # 正则表达式，匹配以a开头的所有字符串，每个apikey对应的请求10qds
  12.       - key: “regexp:^a.“
  13.          token_per_second: 10
  14.       # 正则表达式，匹配以b开头的所有字符串，每个apikey对应的请求100qd
  15.       - key: “regexp:^b.“
  16.         token_per_minute: 100
  17.       # 兜底用，匹配所有请求，每个apikey对应的请求1000qdh
  18.       - key: “*”
  19.         token_per_hour: 1000
  20. redis:
  21.   service_name: redis.static

识别请求头 x-ca-key，进行区别限流

  1. rule_name: default_rule
  2. rule_items:
  3.   - limit_by_header: x-ca-key
  4.     limit_keys:
  5.       - key: 102234
  6.         token_per_minute: 10
  7.       - key: 308239
  8.         token_per_hour: 10
  9.   - limit_by_per_header: x-ca-key
  10.     limit_keys:
  11.       # 正则表达式，匹配以a开头的所有字符串，每个apikey对应的请求10qds
  12.       - key: “regexp:^a.“
  13.         token_per_second: 10
  14.       # 正则表达式，匹配以b开头的所有字符串，每个apikey对应的请求100qd
  15.       - key: “regexp:^b.“
  16.         token_per_minute: 100
  17.       # 兜底用，匹配所有请求，每个apikey对应的请求1000qdh
  18.       - key: “*”
  19.         token_per_hour: 1000
  20. redis:
  21.   service_name: redis.static

根据请求头 x-forwarded-for 获取对端IP，进行区别限流

  1. rule_name: default_rule
  2. rule_items:
  3.   - limit_by_per_ip: from-header-x-forwarded-for
  4.     limit_keys:
  5.       # 精确ip
  6.       - key: 1.1.1.1
  7.         token_per_day: 10
  8.       # ip段，符合这个ip段的ip，每个ip 100qpd
  9.       - key: 1.1.1.0/24
  10.         token_per_day: 100
  11.       # 兜底用，即默认每个ip 1000qpd
  12.       - key: 0.0.0.0/0
  13.         token_per_day: 1000
  14. redis:
  15.   service_name: redis.static

识别consumer，进行区别限流

  1. rule_name: default_rule
  2. rule_items:
  3.   - limit_by_consumer: ‘’
  4.     limit_keys:
  5.       - key: consumer1
  6.         token_per_second: 10
  7.       - key: consumer2
  8.         token_per_hour: 100
  9.   - limit_by_per_consumer: ‘’
  10.     limit_keys:
  11.       # 正则表达式，匹配以a开头的所有字符串，每个consumer对应的请求10qds
  12.       - key: “regexp:^a.“
  13.         token_per_second: 10
  14.       # 正则表达式，匹配以b开头的所有字符串，每个consumer对应的请求100qd
  15.       - key: “regexp:^b.“
  16.         token_per_minute: 100
  17.       # 兜底用，匹配所有请求，每个consumer对应的请求1000qdh
  18.       - key: “*”
  19.         token_per_hour: 1000
  20. redis:
  21.   service_name: redis.static

识别cookie中的键值对，进行区别限流

  1. rule_name: default_rule
  2. rule_items:
  3.   - limit_by_cookie: key1
  4.     limit_keys:
  5.       - key: value1
  6.         token_per_minute: 10
  7.       - key: value2
  8.         token_per_hour: 100
  9.   - limit_by_per_cookie: key1
  10.     limit_keys:
  11.       # 正则表达式，匹配以a开头的所有字符串，每个cookie中的value对应的请求10qds
  12.       - key: “regexp:^a.“
  13.         token_per_second: 10
  14.       # 正则表达式，匹配以b开头的所有字符串，每个cookie中的value对应的请求100qd
  15.       - key: “regexp:^b.“
  16.         token_per_minute: 100
  17.       # 兜底用，匹配所有请求，每个cookie中的value对应的请求1000qdh
  18.       - key: “*”
  19.         token_per_hour: 1000
  20. rejected_code: 200
  21. rejected_msg: ‘{“code”:-1,”msg”:”Too many requests”}’
  22. redis:
  23.   service_name: redis.static