client-control

Description

The client-control plugin dynamically controls the behavior of Nginx to handle the client request.

This plugin requires APISIX to run on APISIX-Base.

Attributes

NameTypeRequirementDefaultValidDescription
max_body_sizeintegeroptional>= 0dynamically set the client_max_body_size directive

How To Enable

Here’s an example, enable this plugin on the specified route:

  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. }'

Test Plugin

Use curl to access:

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

Disable Plugin

When you want to disable this plugin, it is very simple, you can delete the corresponding json configuration in the plugin configuration, no need to restart the service, it will take effect immediately:

  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. }'

This plugin has been disabled now. It works for other plugins.