Skip to main content
Version: 2.5

request-id

目录#

名称#

request-id 插件通过 APISIX 为每一个请求代理添加唯一 ID(UUID),以用于追踪 API 请求。该插件在 header_name 已经在请求中存在时不会为请求添加新的 ID。

属性#

名称类型必选项默认值有效值描述
header_namestring可选"X-Request-Id"Request ID header name
include_in_responseboolean可选false是否需要在返回头中包含该唯一ID

如何启用#

创建一条路由并在该路由上启用 request-id 插件:

curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/hello",    "plugins": {        "request-id": {            "include_in_response": true        }    },    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:8080": 1        }    }}'

测试插件#

$ curl -i http://127.0.0.1:9080/helloHTTP/1.1 200 OKX-Request-Id: fe32076a-d0a5-49a6-a361-6c244c1df956......

禁用插件#

在路由 plugins 配置块中删除 `request-id 配置,即可禁用该插件,无需重启 APISIX。

curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/get",    "plugins": {    },    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:8080": 1        }    }}'