跳到主要内容

参数

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

  • header_name

    string


    默认值:X-Request-Id


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

  • include_in_response

    boolean


    默认值:true


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

  • algorithm

    string


    默认值:uuid


    有效值:

    uuidnanoidrange_idksuiduuidv7


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

    当设置为 uuid 时,插件生成通用唯一标识符;设置为 nanoid 时,生成紧凑且 URL 安全的 ID;设置为 range_id 时,使用特定参数生成顺序 ID;设置为 ksuid 时,生成可按时间排序的全局唯一 ID。ksuid 自 APISIX 3.14.0 和 API7 企业版 3.9.0 起可用。设置为 uuidv7 时,插件生成 UUID v7 标识符(RFC 9562),其中包含毫秒精度时间戳和随机位,使 ID 可按时间和字典序排序。自 API7 企业版 3.9.8 和 APISIX 3.17.0 起可用。

  • range_id

    object


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

    • char_set

      string


      默认值:abcdefghijklmnopqrstuvwxyzABCDEFGHIGKLMNOPQRSTUVWXYZ0123456789


      有效值:

      最小长度为 6


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

    • length

      integer


      默认值:16


      有效值:

      大于或等于 6


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