Workflow 配置选项
workflow 插件根据特定规则,对客户端流量有条件地执行用户定义的动作,从而支持细粒度的 API 流量管理。 配置涵盖插件参数。
参数
有关所有插件均可使用的配置项,请参阅插件通用配置。
rules
按顺序评估的规则。只有第一条匹配规则会执行其动作。
case
以 APISIX 表达式表示的匹配条件。省略时,规则始终匹配。请把无条件回退规则放在最后。在 APISIX 3.19.0 中,无效表达式会在配置校验期间被拒绝。
actions
条件匹配成功时要执行的动作数组。目前,该数组仅支持一个动作,且应为
return、limit-count或limit-conn。如果你使用的是 API7 企业版,还可以使用limit-count-advanced作为动作。每个动作是一个包含两个元素的数组
[name, conf],其中name为动作名称,conf为其配置对象。每条规则必须恰好包含一个动作。APISIX 3.19.0 会在配置校验期间强制执行该结构,API7 企 业版 3.9.21 和 3.10.8 则由控制面执行。没有配置对象的动作、包含多余元素的动作,以及包含多个动作的规则都会被拒绝。当动作设置为
return时,你可以配置在匹配条件时返回给客户端的 HTTP 状态码。当动作设置为
limit-count时,你可以配置limit-count插件的所有选项,但group除外。当动作设置为
limit-count-advanced时,你可以配置limit-count-advanced插件的所有选项,但group除外。当动作设置为
limit-conn时,你可以配置limit-conn插件的所有选项。