Skip to main content

Parameters

See plugin common configurations for configuration options available to all plugins.

  • abort

    object


    Abort action configurations.

    • http_status

      integer

      required

      vaild vaule:

      greater than or equal to 200


      Response HTTP status code to return to client.

    • body

      string


      Body of the response returned to the client. Support the use of built-in variables in the body.

    • headers

      object


      Headers of the response returned to the client. Support the use of built-in variables in headers.

    • percentage

      integer

      vaild vaule:

      between 0 and 100 inclusive


      Percentage of requests to be aborted.

    • vars

      array[array]


      An array of one or more matching conditions in the form of APISIX expressions to conditionally execute the plugin.

  • delay

    object


    Delay action configurations.

    • duration

      number

      required


      Delay duration in seconds.

    • percentage

      integer

      vaild vaule:

      between 0 and 100 inclusive


      Percentage of requests to be delayed.

    • vars

      array[array]


      An array of one or more matching conditions in the form of APISIX expressions to conditionally execute the plugin.