lunarwhite opened a new pull request, #7930: URL: https://github.com/apache/apisix/pull/7930 ### Description update documents under `docs/zh/latest/plugins/` along with `docs/en/latest/plugins/` ### Checklist - [x] I have explained the need for this PR and the problem it solves - [x] I have explained the changes or the new features added to this PR - [ ] I have added tests corresponding to this change - [x] I have updated the documentation to reflect this change - [x] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first) <!-- Note 1. Mark the PR as draft until it's ready to be reviewed. 2. Always add/update tests for any changes unless you have a good reason. 3. Always update the documentation to reflect the changes made in the PR. 4. Make a new commit to resolve conversations instead of `push -f`. 5. To resolve merge conflicts, merge master instead of rebasing. 6. Use "request review" to notify the reviewer after making changes. 7. Only a reviewer can mark a conversation as resolved. --> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org For queries about this service, please contact Infrastructure at: users@infra.apache.org
SylviaBABY commented on code in PR #7930:
URL: https://github.com/apache/apisix/pull/7930#discussion_r973809312
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -1,5 +1,10 @@
---
title: limit-count
+keywords:
+ - APISIX
+ - API 网关
+ - Limit Count
Review Comment:
```suggestion
- Limit Count
- 速率限制
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +28,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
+| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置。 |
+| key_type | string | 否 | "var" | ["var", "var_combination", "constant"] | key 的类型。 |
+| key | string | 否 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 `constant`，那么 key 会被当作常量；如果 `key_type` 为 `var`，那么 key 会被当作变量；如果 `key_type` 为 `var_combination`，那么 key 会被当作变量组合，如 `$remote_addr $consumer_name`，插件会同时受 `$remote_addr` 和 `$consumer_name` 两个变量的约束；如果 key 的值为空，`$remote_addr` 会被作为默认 key。 |
+| rejected_code | integer | 否 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码。 |
+| rejected_msg | string | 否 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
+| policy | string | 否 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。当设置为 `local` 时，计数器被以内存方式保存在节点本地；当设置为 `redis` 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 `redis-cluster` 时，使用 Redis 集群而不是单个实例。 |
+| allow_degradation | boolean | 否 | false | | 当设置为 `true` 时，当插件功能临时不可用时（如 Redis 超时），使插件降级并允许请求继续。 |
Review Comment:
```suggestion
| allow_degradation | boolean | 否 | false | | 当插件功能临时不可用时（如 Redis 超时），设置为 `true` 则代表可以允许插件降级并进行继续请求的操作。 |
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -243,13 +246,13 @@ curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335
## 测试插件
-上述配置限制了 60 秒内只能访问 2 次，前两次访问都会正常访问：
+上述配置限制了请求 60 秒内只能访问 2 次，通过 `curl` 命令测试请求访问：
Review Comment:
```suggestion
上述配置限制了 60 秒内，请求只能访问 2 次。可通过 `curl` 命令测试请求访问：
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
hf400159 commented on code in PR #7930: URL: https://github.com/apache/apisix/pull/7930#discussion_r974981975 ########## docs/zh/latest/plugins/limit-count.md: ########## @@ -23,39 +29,37 @@ title: limit-count ## 描述 -和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似， -在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。 +和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。 Review Comment: ```suggestion `limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。该插件的原理与 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似。 ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org For queries about this service, please contact Infrastructure at: users@infra.apache.org
SylviaBABY commented on code in PR #7930: URL: https://github.com/apache/apisix/pull/7930#discussion_r974856729 ########## docs/zh/latest/plugins/limit-count.md: ########## @@ -23,39 +29,37 @@ title: limit-count ## 描述 -和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似， -在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。 +和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。 ## 属性 | 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 | | ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 | -| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 | -| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 | -| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 | -| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 | -| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 | -| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 | -| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。| -| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 | -| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 | -| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 | -| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 | -| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 | -| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 | -| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 | -| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 | -| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 | - -## 如何使用 - -### 开启插件 - -下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`： +| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 | +| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置。 | Review Comment: ```suggestion | time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间计数就会重置。 | ``` ########## docs/zh/latest/plugins/limit-count.md: ########## @@ -243,13 +247,13 @@ curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335 ## 测试插件 -上述配置限制了 60 秒内只能访问 2 次，前两次访问都会正常访问： +上述配置限制了 60 秒内请求只能访问 2 次，可通过 `curl` 命令测试请求访问： ```shell curl -i http://127.0.0.1:9080/index.html ``` -响应头里面包含了 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`，他们的含义分别是限制的总请求数和剩余还可以发送的请求数： +前两次都会正常访问，响应头里面包含了 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining` 字段，分别代表限制的总请求数和剩余还可以发送的请求数： Review Comment: ```suggestion 在执行测试命令的前两次都会正常访问。其中响应头中包含了 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining` 字段，分别代表限制的总请求数和剩余还可以发送的请求数： ``` ########## docs/zh/latest/plugins/limit-count.md: ########## @@ -243,13 +247,13 @@ curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335 ## 测试插件 -上述配置限制了 60 秒内只能访问 2 次，前两次访问都会正常访问： +上述配置限制了 60 秒内请求只能访问 2 次，可通过 `curl` 命令测试请求访问： Review Comment: ```suggestion 在上文提到的配置中，其限制了 60 秒内请求只能访问 2 次，可通过如下 `curl` 命令测试请求访问： ``` ########## docs/zh/latest/plugins/limit-count.md: ########## @@ -100,13 +105,11 @@ curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335 }' ``` -你也可以通过 web 界面来完成上面的操作，先增加一个 route，然后在插件页面中添加 limit-count 插件： - - -我们也支持在多个 Route 间共享同一个限流计数器。举个例子， +我们也支持在多个 Route 间共享同一个限流计数器。首先通过以下命令创建一个 Service： Review Comment: ```suggestion APISIX 也支持在多个路由间共享同一个限流计数器。首先通过以下命令创建一个 Service： ``` ########## docs/zh/latest/plugins/limit-count.md: ########## @@ -261,25 +265,17 @@ X-RateLimit-Remaining: 0 Server: APISIX web server ``` -当你第三次访问的时候，就会收到包含 503 返回码的响应头： +当第三次访问时，会收到包含 `503` HTTP 状态码的响应头，表示插件生效： Review Comment: ```suggestion 当第三次进行测试访问时，会收到包含 `503` HTTP 状态码的响应头，表示插件生效： ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org For queries about this service, please contact Infrastructure at: users@infra.apache.org
hf400159 commented on code in PR #7930:
URL: https://github.com/apache/apisix/pull/7930#discussion_r973721126
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -1,5 +1,10 @@
---
title: limit-count
+keywords:
+ - APISIX
+ - API 网关
+ - Limit Count
+description: 本文介绍了 Apache APISIX limit-conn 插件的相关操作，你可以使用此插件限制客户端在指定的时间范围内对服务的总请求数。
Review Comment:
```suggestion
description: 本文介绍了 Apache APISIX limit-count 插件的相关操作，你可以使用此插件限制客户端在指定的时间范围内对服务的总请求数。
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
Review Comment:
```suggestion
`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。该插件原理与 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似。
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +28,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
Review Comment:
```suggestion
`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。该插件功能与 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit)功能类似。
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
Review Comment:
```suggestion
| count | integer | 是 | | count > 0 | 每个客户端在指定时间窗口内的总请求数量阈值。 |
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
+| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间计数就会重置。 |
Review Comment:
```suggestion
| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位）。超过该属性定义的时间，则会重新开始计数。 |
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
+| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间计数就会重置。 |
+| key_type | string | 否 | "var" | ["var", "var_combination", "constant"] | key 的类型。 |
+| key | string | 否 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 `constant`，那么 key 会被当作常量；如果 `key_type` 为 `var`，那么 key 会被当作变量；如果 `key_type` 为 `var_combination`，那么 key 会被当作变量组合，如 `$remote_addr $consumer_name`，插件会同时受 `$remote_addr` 和 `$consumer_name` 两个变量的约束；如果 key 的值为空，`$remote_addr` 会被作为默认 key。 |
+| rejected_code | integer | 否 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码。 |
+| rejected_msg | string | 否 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
+| policy | string | 否 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。当设置为 `local` 时，计数器被以内存方式保存在节点本地；当设置为 `redis` 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 `redis-cluster` 时，使用 Redis 集群而不是单个实例。 |
+| allow_degradation | boolean | 否 | false | | 当插件功能临时不可用时（如 Redis 超时），设置为 `true` 则代表可以允许插件降级并进行继续请求的操作。 |
Review Comment:
```suggestion
| allow_degradation | boolean | 否 | false | | 当插件功能临时不可用时（例如 Redis 超时），当设置为 `true` 时，则表示可以允许插件降级并进行继续请求的操作。 |
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -100,13 +105,11 @@ curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335
}'
```
-你也可以通过 web 界面来完成上面的操作，先增加一个 route，然后在插件页面中添加 limit-count 插件：
-
-
-我们也支持在多个 Route 间共享同一个限流计数器。举个例子，
+APISIX 也支持在多个路由间共享同一个限流计数器。首先通过以下命令创建一个 Service：
Review Comment:
```suggestion
APISIX 支持在多个路由间共享同一个限流计数器。首先通过以下命令创建一个服务：
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
+| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间计数就会重置。 |
+| key_type | string | 否 | "var" | ["var", "var_combination", "constant"] | key 的类型。 |
+| key | string | 否 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 `constant`，那么 key 会被当作常量；如果 `key_type` 为 `var`，那么 key 会被当作变量；如果 `key_type` 为 `var_combination`，那么 key 会被当作变量组合，如 `$remote_addr $consumer_name`，插件会同时受 `$remote_addr` 和 `$consumer_name` 两个变量的约束；如果 key 的值为空，`$remote_addr` 会被作为默认 key。 |
+| rejected_code | integer | 否 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码。 |
+| rejected_msg | string | 否 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
+| policy | string | 否 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。当设置为 `local` 时，计数器被以内存方式保存在节点本地；当设置为 `redis` 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 `redis-cluster` 时，使用 Redis 集群而不是单个实例。 |
+| allow_degradation | boolean | 否 | false | | 当插件功能临时不可用时（如 Redis 超时），设置为 `true` 则代表可以允许插件降级并进行继续请求的操作。 |
+| show_limit_quota_header | boolean | 否 | true | | 当设置为 `true` 时，在响应头中显示 `X-RateLimit-Limit`（限制的总请求数）和 `X-RateLimit-Remaining`（剩余还可以发送的请求数）字段。 |
+| group | string | 否 | | 非空 | 配置相同 group 的路由将共享相同的限流计数器。 |
+| redis_host | string | 当 policy 属性为 `redis` 时必填 | | | 当使用 `redis` 限速策略时，Redis 服务节点的地址。 |
+| redis_port | integer | 否 | 6379 | [1,...] | 当使用 `redis` 限速策略时，Redis 服务节点的端口。 |
+| redis_password | string | 否 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，Redis 服务节点的密码。 |
+| redis_database | integer | 否 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，Redis 服务节点中使用的 `database`，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
+| redis_timeout | integer | 否 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，Redis 服务节点的超时时间（以毫秒为单位）。 |
+| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，Redis 集群服务节点的地址列表（至少需要两个地址）。 |
+| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，Redis 集群服务节点的名称。 |
Review Comment:
```suggestion
| redis_cluster_name | string | 否 | | | 当使用 `redis-cluster` 限速策略时，Redis 集群服务节点的名称。**当 `policy` 设置为 `redis-cluster` 时必选。** |
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -126,35 +129,37 @@ curl -i http://127.0.0.1:9180/apisix/admin/services/1 -H 'X-API-KEY: edd1c9f0343
}'
```
-每个配置了 `group` 为 `services_1#1640140620` 的 Route 都将共享同一个每个 IP 地址每分钟只能访问一次的计数器。
+然后为路由配置 `service_id` 为 `1` ，不同路由将共享同一个计数器：
```shell
-$ curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl -i http://127.0.0.1:9180/apisix/admin/routes/1 \
+-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"service_id": "1",
"uri": "/hello"
}'
+```
-$ curl -i http://127.0.0.1:9180/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+```shell
+curl -i http://127.0.0.1:9180/apisix/admin/routes/2 \
+-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"service_id": "1",
"uri": "/hello2"
}'
+```
-$ curl -i http://127.0.0.1:9080/hello
-HTTP/1.1 200 ...
+:::note 注意
-$ curl -i http://127.0.0.1:9080/hello2
-HTTP/1.1 503 ...
-```
+同一个 `group` 里面的 `limit-count` 配置必须一致。所以一旦修改了配置，我们需要更新对应的 `group` 的值。
Review Comment:
```suggestion
同一个 `group` 里面的 `limit-count` 的配置必须保持一致。如果一旦修改了配置，你需要更新对应的 `group` 的值。
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
+| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间计数就会重置。 |
+| key_type | string | 否 | "var" | ["var", "var_combination", "constant"] | key 的类型。 |
+| key | string | 否 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 `constant`，那么 key 会被当作常量；如果 `key_type` 为 `var`，那么 key 会被当作变量；如果 `key_type` 为 `var_combination`，那么 key 会被当作变量组合，如 `$remote_addr $consumer_name`，插件会同时受 `$remote_addr` 和 `$consumer_name` 两个变量的约束；如果 key 的值为空，`$remote_addr` 会被作为默认 key。 |
+| rejected_code | integer | 否 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码。 |
+| rejected_msg | string | 否 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
+| policy | string | 否 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。当设置为 `local` 时，计数器被以内存方式保存在节点本地；当设置为 `redis` 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 `redis-cluster` 时，使用 Redis 集群而不是单个实例。 |
+| allow_degradation | boolean | 否 | false | | 当插件功能临时不可用时（如 Redis 超时），设置为 `true` 则代表可以允许插件降级并进行继续请求的操作。 |
+| show_limit_quota_header | boolean | 否 | true | | 当设置为 `true` 时，在响应头中显示 `X-RateLimit-Limit`（限制的总请求数）和 `X-RateLimit-Remaining`（剩余还可以发送的请求数）字段。 |
+| group | string | 否 | | 非空 | 配置相同 group 的路由将共享相同的限流计数器。 |
+| redis_host | string | 当 policy 属性为 `redis` 时必填 | | | 当使用 `redis` 限速策略时，Redis 服务节点的地址。 |
+| redis_port | integer | 否 | 6379 | [1,...] | 当使用 `redis` 限速策略时，Redis 服务节点的端口。 |
+| redis_password | string | 否 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，Redis 服务节点的密码。 |
+| redis_database | integer | 否 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，Redis 服务节点中使用的 `database`，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
+| redis_timeout | integer | 否 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，Redis 服务节点的超时时间（以毫秒为单位）。 |
Review Comment:
```suggestion
| redis_timeout | integer | 否 | 1000 | [1,...] | 当 `policy` 设置为 `redis` 或 `redis-cluster` 时，Redis 服务节点的超时时间（以毫秒为单位）。 |
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
+| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间计数就会重置。 |
+| key_type | string | 否 | "var" | ["var", "var_combination", "constant"] | key 的类型。 |
+| key | string | 否 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 `constant`，那么 key 会被当作常量；如果 `key_type` 为 `var`，那么 key 会被当作变量；如果 `key_type` 为 `var_combination`，那么 key 会被当作变量组合，如 `$remote_addr $consumer_name`，插件会同时受 `$remote_addr` 和 `$consumer_name` 两个变量的约束；如果 key 的值为空，`$remote_addr` 会被作为默认 key。 |
+| rejected_code | integer | 否 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码。 |
+| rejected_msg | string | 否 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
+| policy | string | 否 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。当设置为 `local` 时，计数器被以内存方式保存在节点本地；当设置为 `redis` 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 `redis-cluster` 时，使用 Redis 集群而不是单个实例。 |
+| allow_degradation | boolean | 否 | false | | 当插件功能临时不可用时（如 Redis 超时），设置为 `true` 则代表可以允许插件降级并进行继续请求的操作。 |
+| show_limit_quota_header | boolean | 否 | true | | 当设置为 `true` 时，在响应头中显示 `X-RateLimit-Limit`（限制的总请求数）和 `X-RateLimit-Remaining`（剩余还可以发送的请求数）字段。 |
+| group | string | 否 | | 非空 | 配置相同 group 的路由将共享相同的限流计数器。 |
+| redis_host | string | 当 policy 属性为 `redis` 时必填 | | | 当使用 `redis` 限速策略时，Redis 服务节点的地址。 |
Review Comment:
```suggestion
| redis_host | string | 否 | | | 当使用 `redis` 限速策略时，Redis 服务节点的地址。**当 `policy` 属性设置为 `redis` 时必选。** |
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
+| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间计数就会重置。 |
+| key_type | string | 否 | "var" | ["var", "var_combination", "constant"] | key 的类型。 |
+| key | string | 否 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 `constant`，那么 key 会被当作常量；如果 `key_type` 为 `var`，那么 key 会被当作变量；如果 `key_type` 为 `var_combination`，那么 key 会被当作变量组合，如 `$remote_addr $consumer_name`，插件会同时受 `$remote_addr` 和 `$consumer_name` 两个变量的约束；如果 key 的值为空，`$remote_addr` 会被作为默认 key。 |
+| rejected_code | integer | 否 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码。 |
+| rejected_msg | string | 否 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
+| policy | string | 否 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。当设置为 `local` 时，计数器被以内存方式保存在节点本地；当设置为 `redis` 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 `redis-cluster` 时，使用 Redis 集群而不是单个实例。 |
Review Comment:
```suggestion
| policy | string | 否 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制计数的策略。当设置为 `local` 时，计数器被以内存方式保存在节点本地；当设置为 `redis` 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 `redis-cluster` 时，使用 Redis 集群而不是单个实例。 |
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
+| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间计数就会重置。 |
+| key_type | string | 否 | "var" | ["var", "var_combination", "constant"] | key 的类型。 |
+| key | string | 否 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 `constant`，那么 key 会被当作常量；如果 `key_type` 为 `var`，那么 key 会被当作变量；如果 `key_type` 为 `var_combination`，那么 key 会被当作变量组合，如 `$remote_addr $consumer_name`，插件会同时受 `$remote_addr` 和 `$consumer_name` 两个变量的约束；如果 key 的值为空，`$remote_addr` 会被作为默认 key。 |
+| rejected_code | integer | 否 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码。 |
+| rejected_msg | string | 否 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
+| policy | string | 否 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。当设置为 `local` 时，计数器被以内存方式保存在节点本地；当设置为 `redis` 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 `redis-cluster` 时，使用 Redis 集群而不是单个实例。 |
+| allow_degradation | boolean | 否 | false | | 当插件功能临时不可用时（如 Redis 超时），设置为 `true` 则代表可以允许插件降级并进行继续请求的操作。 |
+| show_limit_quota_header | boolean | 否 | true | | 当设置为 `true` 时，在响应头中显示 `X-RateLimit-Limit`（限制的总请求数）和 `X-RateLimit-Remaining`（剩余还可以发送的请求数）字段。 |
+| group | string | 否 | | 非空 | 配置相同 group 的路由将共享相同的限流计数器。 |
+| redis_host | string | 当 policy 属性为 `redis` 时必填 | | | 当使用 `redis` 限速策略时，Redis 服务节点的地址。 |
+| redis_port | integer | 否 | 6379 | [1,...] | 当使用 `redis` 限速策略时，Redis 服务节点的端口。 |
+| redis_password | string | 否 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，Redis 服务节点的密码。 |
+| redis_database | integer | 否 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，Redis 服务节点中使用的 `database`，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
+| redis_timeout | integer | 否 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，Redis 服务节点的超时时间（以毫秒为单位）。 |
+| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，Redis 集群服务节点的地址列表（至少需要两个地址）。 |
Review Comment:
```suggestion
| redis_cluster_nodes | array | | | | 当使用 `redis-cluster` 限速策略时，Redis 集群服务节点的地址列表（至少需要两个地址）。** 当 `policy` 属性设置为 `redis-cluster` 时必填**。 |
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -175,17 +180,15 @@ curl -i http://127.0.0.1:9180/apisix/admin/services/1 -H 'X-API-KEY: edd1c9f0343
}'
```
-在上面的例子中，我们将 `key_type` 设置为 `constant`。
-通过设置 `key_type` 为 `constant`，`key` 的值将会直接作为常量来处理。
+现在即使请求来自不同的 IP 地址，每个配置了 `group` 为 `services_1#1640140620` 的路由上的所有请求都将共享同一个计数器。
Review Comment:
```suggestion
以上配置表示：当多个路由中 `limit-count` 插件的 `group` 属性均配置为 `services_1#1640140620` 时，访问这些路由的请求将会共享同一个计数器，即使这些请求来自于不同的 IP 地址。
```
##########
docs/zh/latest/plugins/limit-count.md:
##########
@@ -23,39 +29,37 @@ title: limit-count
## 描述
-和 [GitHub API 的限速](https://docs.github.com/en/rest/reference/rate-limit) 类似，
-在指定的时间范围内，限制总的请求个数。并且在 HTTP 响应头中返回剩余可以请求的个数。
+和 [GitHub API 的速率限制](https://docs.github.com/en/rest/reference/rate-limit)类似，`limit-count` 插件用于限制客户端在指定的时间范围内对服务的总请求数，并且在 HTTP 响应头中返回剩余可以请求的个数。
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| ------------------- | ------- | --------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| count | integer | 必须 | | count > 0 | 指定时间窗口内的请求数量阈值 |
-| time_window | integer | 必须 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间就会重置 |
-| key_type | string | 可选 | "var" | ["var", "var_combination", "constant"] | key 的类型 |
-| key | string | 可选 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 "constant"，那么 key 会被当作常量。如果 `key_type` 为 "var"，那么 key 会被当作变量名称。如果 `key_type` 为 "var_combination"，那么 key 会当作变量组。比如如果设置 "$remote_addr $consumer_name" 作为 key，那么插件会同时受 remote_addr 和 consumer_name 两个变量的约束。如果 key 的值为空，$remote_addr 会被作为默认 key。 |
-| rejected_code | integer | 可选 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码 |
-| rejected_msg | string | 可选 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
-| policy | string | 可选 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。可选的值有：`local`(计数器被以内存方式保存在节点本地，默认选项) 和 `redis`(计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速)；以及`redis-cluster`，跟 redis 功能一样，只是使用 redis 集群方式。 |
-| allow_degradation | boolean | 可选 | false | | 当限流插件功能临时不可用时（例如，Redis 超时）是否允许请求继续。当值设置为 true 时则自动允许请求继续，默认值是 false。|
-| show_limit_quota_header | boolean | 可选 | true | | 是否在响应头中显示 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`（限制的总请求数和剩余还可以发送的请求数），默认值是 true。 |
-| group | string | 可选 | | 非空 | 配置同样的 group 的 Route 将共享同样的限流计数器 |
-| redis_host | string | `redis` 必须 | | | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的地址。 |
-| redis_port | integer | 可选 | 6379 | [1,...] | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点的端口 |
-| redis_password | string | 可选 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点的密码。 |
-| redis_database | integer | 可选 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，该属性是 Redis 服务节点中使用的 database，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
-| redis_timeout | integer | 可选 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，该属性是 Redis 服务节点以毫秒为单位的超时时间 |
-| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的地址列表（至少需要两个地址）。 |
-| redis_cluster_name | string | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，该属性是 Redis 集群服务节点的名称。 |
-
-## 如何使用
-
-### 开启插件
-
-下面是一个示例，在指定的 `route` 上开启了 `limit count` 插件，并设置 `key_type` 为 `var`：
+| count | integer | 是 | | count > 0 | 指定时间窗口内的请求数量阈值。 |
+| time_window | integer | 是 | | time_window > 0 | 时间窗口的大小（以秒为单位），超过这个时间计数就会重置。 |
+| key_type | string | 否 | "var" | ["var", "var_combination", "constant"] | key 的类型。 |
+| key | string | 否 | "remote_addr" | | 用来做请求计数的依据。如果 `key_type` 为 `constant`，那么 key 会被当作常量；如果 `key_type` 为 `var`，那么 key 会被当作变量；如果 `key_type` 为 `var_combination`，那么 key 会被当作变量组合，如 `$remote_addr $consumer_name`，插件会同时受 `$remote_addr` 和 `$consumer_name` 两个变量的约束；如果 key 的值为空，`$remote_addr` 会被作为默认 key。 |
+| rejected_code | integer | 否 | 503 | [200,...,599] | 当请求超过阈值被拒绝时，返回的 HTTP 状态码。 |
+| rejected_msg | string | 否 | | 非空 | 当请求超过阈值被拒绝时，返回的响应体。 |
+| policy | string | 否 | "local" | ["local", "redis", "redis-cluster"] | 用于检索和增加限制的速率限制策略。当设置为 `local` 时，计数器被以内存方式保存在节点本地；当设置为 `redis` 时，计数器保存在 Redis 服务节点上，从而可以跨节点共享结果，通常用它来完成全局限速；当设置为 `redis-cluster` 时，使用 Redis 集群而不是单个实例。 |
+| allow_degradation | boolean | 否 | false | | 当插件功能临时不可用时（如 Redis 超时），设置为 `true` 则代表可以允许插件降级并进行继续请求的操作。 |
+| show_limit_quota_header | boolean | 否 | true | | 当设置为 `true` 时，在响应头中显示 `X-RateLimit-Limit`（限制的总请求数）和 `X-RateLimit-Remaining`（剩余还可以发送的请求数）字段。 |
+| group | string | 否 | | 非空 | 配置相同 group 的路由将共享相同的限流计数器。 |
+| redis_host | string | 当 policy 属性为 `redis` 时必填 | | | 当使用 `redis` 限速策略时，Redis 服务节点的地址。 |
+| redis_port | integer | 否 | 6379 | [1,...] | 当使用 `redis` 限速策略时，Redis 服务节点的端口。 |
+| redis_password | string | 否 | | | 当使用 `redis` 或者 `redis-cluster` 限速策略时，Redis 服务节点的密码。 |
+| redis_database | integer | 否 | 0 | redis_database >= 0 | 当使用 `redis` 限速策略时，Redis 服务节点中使用的 `database`，并且只针对非 Redis 集群模式（单实例模式或者提供单入口的 Redis 公有云服务）生效。 |
+| redis_timeout | integer | 否 | 1000 | [1,...] | 当使用 `redis` 或者 `redis-cluster` 限速策略时，Redis 服务节点的超时时间（以毫秒为单位）。 |
+| redis_cluster_nodes | array | 当 policy 为 `redis-cluster` 时必填 | | | 当使用 `redis-cluster` 限速策略时，Redis 集群服务节点的地址列表（至少需要两个地址）。 |
Review Comment:
```suggestion
| redis_cluster_nodes | array | 否 | | | 当使用 `redis-cluster` 限速策略时，Redis 集群服务节点的地址列表（至少需要两个地址）。**当 `policy` 属性设置为 `redis-cluster` 时必选。** |
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
spacewander merged PR #7930: URL: https://github.com/apache/apisix/pull/7930 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org For queries about this service, please contact Infrastructure at: users@infra.apache.org