proxy-control

描述

使用 proxy-control 插件能够动态地控制 NGINX 代理的相关行为。

proxy-control - 图1重要

此插件需要 APISIX 在 APISIX-Runtime 环境上运行。更多信息请参考 apisix-build-tools

属性

名称类型必选项默认值有效值描述
request_bufferingbooleantrue如果设置为 true,插件将动态设置 proxy_request_buffering

启用插件

以下示例展示了如何在指定路由上启用 proxy-control 插件:

proxy-control - 图2note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量:

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl -i http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H "X-API-KEY: $admin_key" -X PUT -d '
  3. {
  4. "uri": "/upload",
  5. "plugins": {
  6. "proxy-control": {
  7. "request_buffering": false
  8. }
  9. },
  10. "upstream": {
  11. "type": "roundrobin",
  12. "nodes": {
  13. "127.0.0.1:1980": 1
  14. }
  15. }
  16. }'

测试插件

启用插件后,使用 curl 命令请求该路由进行一个大文件的上传测试:

  1. curl -i http://127.0.0.1:9080/upload -d @very_big_file

如果在错误日志中没有找到关于 “a client request body is buffered to a temporary file” 的信息,则说明插件生效。

删除插件

当你需要删除该插件时,可以通过以下命令删除相应的 JSON 配置,APISIX 将会自动重新加载相关配置,无需重启服务:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
  2. -H "X-API-KEY: $admin_key" -X PUT -d
  3. {
  4. "uri": "/upload",
  5. "upstream": {
  6. "type": "roundrobin",
  7. "nodes": {
  8. "127.0.0.1:1980": 1
  9. }
  10. }
  11. }'