# Request ID 配置选项

request-id 插件为每个经 API 网关代理的请求添加唯一 ID，便于跟踪 API 请求和管理 API。<!-- --> <!-- -->配置涵盖插件参数。

## 参数[​](#参数 "参数的直接链接")

有关所有插件均可使用的配置项，请参阅[插件通用配置](https://docs.apiseven.com/apisix/reference/plugin-common-configurations.md)。

* header\_name

  string

  默认值：`X-Request-Id`

  ***

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

* include\_in\_response

  boolean

  默认值：`true`

  ***

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

* algorithm

  string

  默认值：`uuid`

  有效值：

  `uuid`、`nanoid`、`range_id`、`ksuid` 或 `uuidv7`

  ***

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

  设置为 `uuid` 时，插件生成通用唯一标识符；设置为 `nanoid` 时，生成紧凑且 URL 安全的 ID；设置为 `range_id` 时，从配置的字符集中随机选取每个字符；设置为 `ksuid` 时，生成可按时间排序的全局唯一 ID。KSUID 支持自 API7 企业版 3.9.0 和 APISIX 3.14.0 起提供。设置为 `uuidv7` 时，插件生成符合 RFC 9562 的 UUID v7，其中包含毫秒时间戳、worker 本地序列和随机位。UUID v7 在单个 worker 内单调递增，但不同 worker 或网关实例之间不保证顺序协调。UUID v7 支持自 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 的长度。
