跳到主要内容

参数​

请参阅 插件通用配置 了解所有插件可用的配置选项。

  • header_name

    string

    default: X-Request-Id

    指定携带请求唯一 ID 的请求头名称。注意，如果请求在 header_name 指定的请求头中已携带 ID，插件将使用该请求头的值作为唯一 ID，而不会用生成的 ID 覆盖它。

  • include_in_response

    boolean

    default: true

    如果为 true，则在响应头中包含生成的请求 ID，请求头名称为 header_name 的值。

  • algorithm

    string

    default: uuid

    vaild vaule:

    uuid, nanoid, range_id, or ksuid

    指定用于生成唯一 ID 的算法。

    当设置为 uuid 时，插件生成一个通用唯一标识符。当设置为 nanoid 时，插件生成一个紧凑的、URL 安全的 ID。当设置为 range_id 时，插件生成一个带有特定参数的顺序 ID。当设置为 ksuid 时，插件生成一个可按时间排序的全局唯一 ID。ksuid 选项在 APISIX 3.14.0 版本及 API7 Enterprise 3.9.0 版本中可用。

  • range_id

    object

    定义使用 range_id 算法生成请求 ID 的配置。

    • char_set

      string

      default: abcdefghijklmnopqrstuvwxyzABCDEFGHIGKLMNOPQRSTUVWXYZ0123456789

      vaild vaule:

      minimum length 6

      指定用于 range_id 算法的字符集。

    • length

      integer

      default: 16

      vaild vaule:

      大于或等于 6

      设置 range_id 算法生成 ID 的长度。