client-control
#
DescriptionThe client-control
Plugin can be used to dynamically control the behavior of NGINX to handle a client request, by setting the max size of the request body.
IMPORTANT
This Plugin requires APISIX to run on APISIX-Runtime. See apisix-build-tools for more info.
#
AttributesName | Type | Required | Valid values | Description |
---|---|---|---|---|
max_body_size | integer | False | [0,...] | Set the maximum limit for the client request body and dynamically adjust the size of client_max_body_size , measured in bytes. If you set the max_body_size to 0, then the size of the client's request body will not be checked. |
#
Enable PluginThe example below enables the Plugin on a specific Route:
curl -i http://127.0.0.1:9180/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": {
"127.0.0.1:1980": 1
}
}
}'
#
Example usageNow since you have configured the max_body_size
to 1
above, you will get the following message when you make a request:
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>
#
Delete PluginTo remove the client-control
Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload, and you do not have to restart for this to take effect.
curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/index.html",
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'