Skip to content

proxy-control

本文介绍了 APIX proxy-control 插件的相关操作,你可以使用此插件动态地控制 NGINX 代理的行为。

描述

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

重要

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

属性

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

启用插件

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

shell
curl -i http://127.0.0.1:9180/apix/admin/routes/1 \
  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/upload",
    "plugins": {
        "proxy-control": {
            "request_buffering": false
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

测试插件

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

shell
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 将会自动重新加载相关配置,无需重启服务:

shell
curl http://127.0.0.1:9180/apix/admin/routes/1 \
  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d
{
    "uri": "/upload",
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'