client-control

描述

client-control 插件能够动态地控制 Nginx 处理客户端的请求的行为。

这个插件需要 APISIX 在 APISIX-OpenResty 上运行。

属性

名称类型必选项默认值有效值描述
max_body_sizeinteger可选>= 0动态设置 client_max_body_size 的大小

如何启用

以下是一个示例，在指定路由中启用插件：

  1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "plugins": {
  5.         "client-control": {
  6.             "max_body_size" : 1
  7.         }
  8.     },
  9.     "upstream": {
  10.         "type": "roundrobin",
  11.         "nodes": {
  12.             "127.0.0.1:1980": 1
  13.         }
  14.     }
  15. }'

测试插件

使用 curl 去测试：

  1. curl -i http://127.0.0.1:9080/index.html -d '123'
  4. HTTP/1.1 413 Request Entity Too Large
  5. ...
  6. <html>
  7. <head><title>413 Request Entity Too Large</title></head>
  8. <body>
  9. <center><h1>413 Request Entity Too Large</h1></center>
  10. <hr><center>openresty</center>
  11. </body>
  12. </html>

禁用插件

当您要禁用 client-control 插件时，这很简单，您可以在插件配置中删除相应的 json 配置，无需重新启动服务，它将立即生效：

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "upstream": {
  5.         "type": "roundrobin",
  6.         "nodes": {
  7.             "127.0.0.1:1980": 1
  8.         }
  9.     }
  10. }'

现在就已经移除 client-control 插件了。其他插件的开启和移除也是同样的方法。