request-size-limiting.md

Request Size Limiting 请求大小限制插件

本文原文链接：https://docs.konghq.com/hub/kong-inc/request-size-limiting/

出于安全原因，我们建议为您添加到Kong的任何服务启用此插件，以防止DOS（拒绝服务）攻击。

阻止正文大于特定大小（以兆字节为单位）的传入请求。

注意：此插件的功能与0.9.0之前的Kong版本捆绑在一起，与此处记录的不同。 有关详细信息，请参阅CHANGELOG。

术语

• plugin: 在请求被代理到上游API之前或之后，在Kong内部执行操作的插件。
• Service: 表示外部 upstream API或微服务的Kong实体。
• Route: 表示将下游请求映射到上游服务的方法的Kong实体。
• Consumer: 代表使用API的开发人员或机器的Kong实体。当使用Kong时，Consumer 仅与Kong通信，其代理对所述上游API的每次调用。
• Credential: 与Consumer关联的唯一字符串，也称为API密钥。
• upstream service: 这是指位于Kong后面的您自己的 API/service，转发客户端请求。

配置

此插件与具有以下协议的请求兼容：

• http
• https

此插件与无DB模式部分兼容。

该插件将使用local策略（不使用数据库）或redis策略（使用独立的Redis，因此它与无DB的兼容）运行良好。该插件不适用于cluster策略，该策略需要写入数据库。

在 Service 上启用插件

通过发出以下请求在Service上配置此插件：

$ curl -X POST http://kong:8001/services/{service}/plugins \
    --data "name=request-size-limiting"  \
    --data "config.allowed_payload_size=128"

不使用数据库：

通过添加此部分在服务上配置此插件执行声明性配置文件：

plugins:
- name: request-size-limiting
  service: {service}
  config: 
    allowed_payload_size: 128

在这两种情况下，{service}都是此插件配置将定位的服务的id或name。

在 Route 上启用插件

使用数据库：

在Route上配置此插件：

$ curl -X POST http://kong:8001/routes/{route}/plugins \
    --data "name=request-size-limiting"  \
    --data "config.allowed_payload_size=128"

不使用数据库：

通过添加此部分在路由上配置此插件执行声明性配置文件：

plugins:
- name: request-size-limiting
  route: {route}
  config: 
    allowed_payload_size: 128

在这两种情况下，{route}是此插件配置将定位的Route的ID或名称。

在 Consumer 上启用插件

使用数据库：

您可以使用http://localhost:8001/plugins在特定的Consumers上启用此插件:

$ curl -X POST http://kong:8001/consumers/{consumer}/plugins \
    --data "name=request-size-limiting" \
     \
    --data "config.allowed_payload_size=128"

不使用数据库：

通过添加此部分在Consumer上配置此插件执行声明性配置文件：

plugins:
- name: request-size-limiting
  consumer: {consumer}
  config: 
    allowed_payload_size: 128

在这两种情况下，{consumer}都是此插件配置将定位的Consumer的id或username。
您可以组合consumer_id和service_id 。 在同一个请求中，进一步缩小插件的范围。

全局插件

• 使用数据库： 可以使用http://kong:8001/plugins/配置所有插件。
• 不使用数据库： 可以通过plugins: 配置所有插件：声明性配置文件中的条目。

与任何 Service ，Route 或 Consumer （或API，如果您使用旧版本的Kong）无关的插件被视为“全局”，并将在每个请求上运行。有关更多信息，请阅读插件参考和插件优先级部分。

参数

以下是可在此插件配置中使用的所有参数的列表：

参数	默认值	描述
name		要使用的插件的名称，在本例中为request-size-limiting
service_id		此插件将定位的 Service 的ID。
route_id		此插件将定位的 Route 的ID。
enabled	true	是否将应用此插件。
consumer_id		此插件将定位的Consumer的id
config.allowed_payload_size	128	允许的请求有效负载大小，以兆字节为单位，默认为128（128000000字节。