Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: delete extra characters #6691

Merged
merged 9 commits into from
Mar 29, 2022
Merged

docs: delete extra characters #6691

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4067fb4
chore: remove extra charactor
Mar 23, 2022
a791ba7
fix: space process
Mar 23, 2022
70a630a
fix: remove space
Mar 23, 2022
18b44e5
fix: remove space
Mar 23, 2022
33d982a
fix: merge
Mar 24, 2022
ba2847b
fix: fix format
Mar 24, 2022
77ad75c
fix: remove blank space
Mar 24, 2022
08f7b83
fix: fix table
Mar 24, 2022
91bcf60
fix: add space
Mar 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/zh/latest/plugins/limit-req.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ title: limit-req
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------- | ------- | ------ | ------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| rate | integer | 必须 | | rate > 0 | 指定的请求速率（以秒为单位），请求速率超过 `rate` 但没有超过 （`rate` + `burst`）的请求会被加上延时。 |
| burst | integer | 必须 | | burst >= 0 | t请求速率超过 （`rate` + `burst`）的请求会被直接拒绝。 |
| key | string | 必须 | | ["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name"] | 用来做请求计数的依据，当前接受的 key 有："remote_addr"(客户端IP地址), "server_addr"(服务端 IP 地址), 请求头中的"X-Forwarded-For" 或 "X-Real-IP"，"consumer_name"(consumer 的 username)。 |
| burst | integer | 必须 | | burst >= 0 | 请求速率超过 （`rate` + `burst`）的请求会被直接拒绝。 |
liangliang4ward marked this conversation as resolved.
Show resolved Hide resolved
| key | string | 必须 | | ["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name"] | 用来做请求计数的依据，当前接受的 key 有："remote_addr"(客户端IP地址), "server_addr"(服务端 IP 地址), 请求头中的"X-Forwarded-For" 或 "X-Real-IP"，"consumer_name"( consumer 的 username )。 |
| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码。 |
| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
| nodelay | boolean | 可选 | false | | 如果 nodelay 为 true， 请求速率超过 `rate` 但没有超过 （`rate` + `burst`）的请求不会加上延迟, 如果是 false，则会加上延迟。 |
| allow_degradation | boolean | 可选 | false | | 当限速插件功能临时不可用时是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
| nodelay | boolean | 可选 | false | | 如果 nodelay 为 true， 请求速率超过 `rate` 但没有超过 （`rate` + `burst`）的请求不会加上延迟, 如果是 false ，则会加上延迟。 |
liangliang4ward marked this conversation as resolved.
Show resolved Hide resolved
| allow_degradation | boolean | 可选 | false | | 当限速插件功能临时不可用时是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false 。|

## 示例

Expand Down Expand Up @@ -137,9 +137,9 @@ Server: APISIX web server

### 如何在 `consumer`上使用

consumer上开启 `limit-req` 插件，需要与授权插件一起配合使用，这里以 key-auth 授权插件为例。
consumer 上开启 `limit-req` 插件，需要与授权插件一起配合使用，这里以 key-auth 授权插件为例。

1、将 `limit-req` 插件绑定到consumer上
1、将 `limit-req` 插件绑定到 consumer 上

```shell
curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Expand Down