Parameters
See plugin common configurations for configuration options available to all plugins.
header_name
string
default:
X-Request-IdSpecify the name of the header that carries the request unique ID. Note that if a request carries an ID in the
header_nameheader, the plugin will use the header value as the unique ID and will not overwrite it with the generated ID.include_in_response
boolean
default:
trueIf true, include the generated request ID in the response header, where the name of the header is the
header_namevalue.algorithm
string
default:
uuidvaild vaule:
uuid,nanoid,range_id, orksuidSpecify the algorithm used for generating the unique ID.
When set to
uuid, the plugin generates a universally unique identifier. When set tonanoid, the plugin generates a compact, URL-safe ID. When set torange_id, the plugin generates a sequential ID with specific parameters. When set toksuid, the plugin generates a time-sortable, globally unique ID. Theksuidoption is available only in Apache APISIX, not in API7 Enterprise.range_id
object
Define the configuration for generating a request ID using the
range_idalgorithm.char_set
string
default:
abcdefghijklmnopqrstuvwxyzABCDEFGHIGKLMNOPQRSTUVWXYZ0123456789vaild vaule:
minimum length 6
Specify the character set used for the
range_idalgorithm.length
integer
default:
16vaild vaule:
greater than or equal to 6
Set the length of the generated ID for the
range_idalgorithm.