更新时间:2025-08-15 GMT+08:00

RateLimitContent

表1 RateLimitContent

参数

是否必选

参数类型

描述

scope

String

流控策略的类型:

  • basic:基础,表示绑定到流控策略的单个API流控时间内能够被调用多少次
  • share:共享,表示绑定到流控策略的所有API流控时间内能够被调用多少次

default_time_unit

String

流控的时间单位,缺省为second:

  • second:秒
  • minute:分钟
  • hour:小时
  • day:天

default_interval

Integer

流量控制的时长单位。与“流量限制次数”配合使用,表示单位时间内的API请求次数上限。输入的值是不超过2147483647的正整数。

api_limit

Integer

API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制。输入的值是不超过2147483647的正整数或-1。

取值为-1时,表示不流控。

app_limit

Integer

APP流量限制是指一个API在时长之内被每个APP访问的次数上限,该数值不超过用户流量限制值。输入的值是不超过2147483647的正整数。

user_limit

Integer

用户流量限制是指一个API在时长之内每一个用户能访问的次数上限,该数值不超过API流量限制值。输入的值是不超过2147483647的正整数。

ip_limit

Integer

源IP流量限制是指一个API在时长之内被每个IP访问的次数上限,该数值不超过API流量限制值。输入的值是不超过2147483647的正整数。

algorithm

String

流控类型。支持的取值:

  • counter:高精度流控
  • haht:高性能流控
  • local:单机流控

specials

Array of RateLimitSpecial objects

基础流控模式下的特殊流控配置列表。

parameters

Array of PluginCommonParameter objects

参数流控模式下的流控参数列表。

rules

Array of RateLimitRule objects

参数流控模式下的流控规则列表。

表2 RateLimitSpecial

参数

是否必选

参数类型

描述

type

String

流控策略的类型。支持的取值:

  • app:应用
  • user:IAM租户

policies

Array of RateLimitSpecialPolicy objects

特殊流控策略列表。

表3 RateLimitSpecialPolicy

参数

是否必选

参数类型

描述

key

String

特殊流控对象值。

limit

Integer

流控时间内特殊对象能够访问API的最大次数限制,取值不能比api_limit大。

表4 PluginCommonParameter

参数

是否必选

参数类型

描述

type

String

参数类型。支持的取值:

  • header:HTTP头域的第一个值
  • query:QueryString的第一个值
  • path:HTTP完整请求路径
  • method:HTTP请求方法
  • system:系统参数

name

String

用于rulesparameters的参数名称。

value

String

参数来源值。

表5 RateLimitRule

参数

是否必选

参数类型

描述

rule_name

String

流控策略规则名称。

match_regex

String

流控规则表达式。详情参看规则表达式说明。

time_unit

String

流控的时间单位,缺省为default_time_unit的值。支持的取值:

  • second:秒
  • minute:分钟
  • hour:小时
  • day:天

interval

Integer

流量控制的时长单位,缺省为default_interval的值。

limit

Integer

流控值,正整数。当为-1时表示当命中此条件时不需要流控。