跳到主要内容

参数​

有关所有插件均可使用的配置项，请参阅插件通用配置。

  • rules

    array[object]

    要执行的一组或多组匹配条件和动作。

    • match

      array[object]

      用于条件流量拆分的匹配规则。

      • vars

        array[array]

        一个或多个 APISIX 表达式 形式的匹配条件数组，用于按条件执行插件。

    • weighted_upstreams

      array[object]

      上游配置列表。

      • upstream_id

        string or integer

        配置的上游对象的 ID。

      • weight

        integer

        默认值：1

        发送到 weighted_upstreams 中该项的相对流量份额。

      • upstream

        object

        内联上游配置。仅应用 name、type、hash_on、key、nodes、timeout、scheme、pass_host 和 upstream_host。

        如需使用健康检查、重试、TLS 设置、长连接池、预热、服务发现或其他上游配置，请创建上游对象并设置 upstream_id。

        • type

          string

          默认值：roundrobin

          有效值：

          roundrobin、chash、ewma 或 least_conn

          在此内联上游内选择节点的负载均衡算法。roundrobin 表示加权轮询，chash 表示一致性哈希，ewma 表示指数加权移动平均，least_conn 表示最少连接。父级 weight 字段控制分配给该上游的流量份额。

        • hash_on

          string

          默认值：vars

          有效值：

          vars、header、cookie、consumer 或 vars_combinations

          当 type 为 chash 时使用。支持对内置变量、请求头、Cookie、消费者或内置变量的组合进行哈希。

        • key

          string

          当 type 为 chash 时使用。当 hash_on 设置为 header 或 cookie 时，key 为必填项。当 hash_on 设置为 consumer 时，无需配置 key，因为 Consumer 名称会自动用作键。

        • scheme

          string

          默认值：http

          有效值：

          API7 网关：http 或 https
          APISIX：http 或 https；APISIX 3.19.0 及更高版本还支持 ws 和 wss

          用于与此内联上游通信的协议。如需使用其他协议，请创建上游对象并设置 upstream_id。

        • nodes

          object

          上游节点的地址。

        • timeout

          object

          连接、发送和接收消息的超时时间（以秒为单位）。

        • pass_host

          string

          默认值：pass

          有效值：

          pass、node 或 rewrite

          决定如何传递主机名的模式。pass 将客户端的主机名传递给上游。node 传递上游节点中配置的主机。rewrite 传递 upstream_host 中配置的值。

        • upstream_host

          string

          当 pass_host 为 rewrite 时使用。上游的主机名。

        • name

          string

          上游的标识符，用于指定服务名称、使用场景等。