client-control
#
Summary#
NameThe client-control
plugin dynamically controls the behavior of Nginx to
handle the client request.
This plugin requires APISIX to run on APISIX-OpenResty.
#
AttributesName | Type | Requirement | Default | Valid | Description |
---|---|---|---|---|---|
max_body_size | integer | optional | >= 0 | dynamically set the client_max_body_size directive |
#
How To EnableHere's an example, enable this plugin on the specified route:
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{ "uri": "/index.html", "plugins": { "client-control": { "max_body_size" : 1 } }, "upstream": { "type": "roundrobin", "nodes": { "39.97.63.215:80": 1 } }}'
#
Test PluginUse curl to access:
curl -i http://127.0.0.1:9080/index.html -d '123'
HTTP/1.1 413 Request Entity Too Large...<html><head><title>413 Request Entity Too Large</title></head><body><center><h1>413 Request Entity Too Large</h1></center><hr><center>openresty</center></body></html>
#
Disable PluginWhen 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:
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{ "uri": "/index.html", "upstream": { "type": "roundrobin", "nodes": { "39.97.63.215:80": 1 } }}'
This plugin has been disabled now. It works for other plugins.