Skip to main content
Version: 2.12

client-control

目录#

名称#

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

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

属性#

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

如何启用#

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

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": {
"127.0.0.1:1980": 1
}
}
}'

测试插件#

使用 curl 去测试:

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>

禁用插件#

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

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": {
"127.0.0.1:1980": 1
}
}
}'

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