参数 | 是否必填 | 说明 |
开启默认策略 | 必填 | 是否开启默认策略;默认策略是 API 级别的流控,独立于所有的流控策略;每次请求时,会先校验默认流控,再校验流控策略。 |
默认流控值 | 开启默认策略后必填 | 默认流控值是指时长内一个 API 能够被访问的次数上限,可输入正整数。 |
默认控制时长 | 开启默认策略后必填 | 支持秒、分钟、小时、天四个单位,与默认流控值搭配使用。 |
限流策略 | 必填 | 设置针对参数的限流策略,同一个参数限流插件内最多创建10条限流策略,限流策略的配置项详见下文。 |
参数 | 是否必填 | 说明 |
策略名称 | 必填 | 当前策略的名称,最多50个字符,要求同一插件下不同策略间名称不能一样。 |
权重 | 必填 | 可输入0-100之间的正整数,权重越大优先级越高,要求同一插件下不同策略间权重不能一样。 |
触发条件 | 选填 | 如果设置了条件,只有当条件符合时,才会执行此条流控策略。 |
流控参数位置 | 必填 | 仅支持填写一个流控参数,需要选择位置并填写参数名。例如:Header.ClientIP 表示,针对 Header 中每个 ClientIP 参数的取值分别进行流控。 流控参数位置支持 Header、Query、Path。Path 参数代表完整 API 路径,不需要填写参数名称。 |
流控参数名称 | 必填 | 仅支持填写一个流控参数,需要选择位置并填写参数名。例如:Header.ClientIP 表示,针对 Header 中每个 ClientIP 参数的取值分别进行流控。 流控参数名称需要和流控参数位置搭配使用。Path 参数代表完整 API 路径,不需要填写参数名称。 |
流控值 | 必填 | 本条策略中针对流控参数的流控值,请输入正整数,必须与控制时长搭配使用。 |
控制时长 | 必填 | 支持秒、分钟、小时、天四个单位,与流控值搭配使用。 |
{"default_window":60, // 限流时间窗口,单位秒,取值 0 时默认限流关闭"default_rate_limit":5, // 限流值,需要正整数"strategies":[ // 参数限流策略列表,至少一个策略,最多 10 个策略{"name":"a", // 策略名称"strategy_weight":0, // 策略执行优先级,数值高先执行,不允许重复"parameters":[ // 限流参数列表,暂时支持 1 个参数{"type":"query", // 限流参数类型,取值范围:[query,header,path]"name":"a" // 限流参数名称,参数类型为 path 时,参数为整个请求路径,不需要传 name}],"rate_limit":1, // 策略限流值,需要正整数"window":1, // 策略限流时间窗口,单位秒"condition":"" // 策略触发条件,空字符串则为无条件执行}]}
本页内容是否解决了您的问题?