This is an automated email from the ASF dual-hosted git repository. github-bot pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/apisix-website.git
The following commit(s) were added to refs/heads/asf-site by this push: new 8f4c6ca Deploy to GitHub pages 8f4c6ca is described below commit 8f4c6cacc619820f3731b29108c8a2d5111fac2f Author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> AuthorDate: Thu Dec 3 09:04:40 2020 +0000 Deploy to GitHub pages --- apisix/admin-api.html | 1 + apisix/admin-api/index.html | 1 + apisix/plugins/limit-count.html | 2 +- apisix/plugins/limit-count/index.html | 2 +- apisix/zh-cn/plugins/limit-count.html | 2 +- apisix/zh-cn/plugins/limit-count/index.html | 2 +- 6 files changed, 6 insertions(+), 4 deletions(-) diff --git a/apisix/admin-api.html b/apisix/admin-api.html index 10a15a6..2427fcb 100644 --- a/apisix/admin-api.html +++ b/apisix/admin-api.html @@ -467,6 +467,7 @@ After successful execution, upstream nodes will not retain the original data, an <p>Example:</p> <pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> curl http://127.0.0.1:9080/apisix/admin/consumers -H <span class="hljs-string">'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'</span> -X PUT -i -d <span class="hljs-string">'</span></span> { + "username": "jack", "plugins": { "key-auth": { "key": "auth-one" diff --git a/apisix/admin-api/index.html b/apisix/admin-api/index.html index 10a15a6..2427fcb 100644 --- a/apisix/admin-api/index.html +++ b/apisix/admin-api/index.html @@ -467,6 +467,7 @@ After successful execution, upstream nodes will not retain the original data, an <p>Example:</p> <pre><code class="hljs css language-shell"><span class="hljs-meta">$</span><span class="bash"> curl http://127.0.0.1:9080/apisix/admin/consumers -H <span class="hljs-string">'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'</span> -X PUT -i -d <span class="hljs-string">'</span></span> { + "username": "jack", "plugins": { "key-auth": { "key": "auth-one" diff --git a/apisix/plugins/limit-count.html b/apisix/plugins/limit-count.html index c3846c2..709de21 100644 --- a/apisix/plugins/limit-count.html +++ b/apisix/plugins/limit-count.html @@ -43,7 +43,7 @@ <tbody> <tr><td>count</td><td>integer</td><td>required</td><td></td><td>[0,...]</td><td>the specified number of requests threshold.</td></tr> <tr><td>time_window</td><td>integer</td><td>required</td><td></td><td>[0,...]</td><td>the time window in seconds before the request count is reset.</td></tr> -<tr><td>key</td><td>string</td><td>required</td><td></td><td>["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name", "service_id"]</td><td>The user specified key to limit the count. <br> Now accept those as key: "remote_addr"(client's IP), "server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header, "consumer_name"(consumer's username) and &q [...] +<tr><td>key</td><td>string</td><td>optional</td><td>"remote_addr"</td><td>["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name", "service_id"]</td><td>The user specified key to limit the count. <br> Now accept those as key: "remote_addr"(client's IP), "server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header, "consumer_name"(cons [...] <tr><td>rejected_code</td><td>integer</td><td>optional</td><td>503</td><td>[200,600]</td><td>The HTTP status code returned when the request exceeds the threshold is rejected, default 503.</td></tr> <tr><td>policy</td><td>string</td><td>optional</td><td>"local"</td><td>["local", "redis", "redis-cluster"]</td><td>The rate-limiting policies to use for retrieving and incrementing the limits. Available values are <code>local</code>(the counters will be stored locally in-memory on the node) and <code>redis</code>(counters are stored on a Redis server and will be shared across the nodes, usually use it to do the global speed limit).</td></tr> <tr><td>redis_host</td><td>string</td><td>required for <code>redis</code></td><td></td><td></td><td>When using the <code>redis</code> policy, this property specifies the address of the Redis server.</td></tr> diff --git a/apisix/plugins/limit-count/index.html b/apisix/plugins/limit-count/index.html index c3846c2..709de21 100644 --- a/apisix/plugins/limit-count/index.html +++ b/apisix/plugins/limit-count/index.html @@ -43,7 +43,7 @@ <tbody> <tr><td>count</td><td>integer</td><td>required</td><td></td><td>[0,...]</td><td>the specified number of requests threshold.</td></tr> <tr><td>time_window</td><td>integer</td><td>required</td><td></td><td>[0,...]</td><td>the time window in seconds before the request count is reset.</td></tr> -<tr><td>key</td><td>string</td><td>required</td><td></td><td>["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name", "service_id"]</td><td>The user specified key to limit the count. <br> Now accept those as key: "remote_addr"(client's IP), "server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header, "consumer_name"(consumer's username) and &q [...] +<tr><td>key</td><td>string</td><td>optional</td><td>"remote_addr"</td><td>["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name", "service_id"]</td><td>The user specified key to limit the count. <br> Now accept those as key: "remote_addr"(client's IP), "server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header, "consumer_name"(cons [...] <tr><td>rejected_code</td><td>integer</td><td>optional</td><td>503</td><td>[200,600]</td><td>The HTTP status code returned when the request exceeds the threshold is rejected, default 503.</td></tr> <tr><td>policy</td><td>string</td><td>optional</td><td>"local"</td><td>["local", "redis", "redis-cluster"]</td><td>The rate-limiting policies to use for retrieving and incrementing the limits. Available values are <code>local</code>(the counters will be stored locally in-memory on the node) and <code>redis</code>(counters are stored on a Redis server and will be shared across the nodes, usually use it to do the global speed limit).</td></tr> <tr><td>redis_host</td><td>string</td><td>required for <code>redis</code></td><td></td><td></td><td>When using the <code>redis</code> policy, this property specifies the address of the Redis server.</td></tr> diff --git a/apisix/zh-cn/plugins/limit-count.html b/apisix/zh-cn/plugins/limit-count.html index fcd1a6f..0d204f8 100644 --- a/apisix/zh-cn/plugins/limit-count.html +++ b/apisix/zh-cn/plugins/limit-count.html @@ -44,7 +44,7 @@ <tbody> <tr><td>count</td><td>integer</td><td>必须</td><td></td><td>[0,...]</td><td>指定时间窗口内的请求数量阈值</td></tr> <tr><td>time_window</td><td>integer</td><td>必须</td><td></td><td>[0,...]</td><td>时间窗口的大小(以秒为单位),超过这个时间就会重置</td></tr> -<tr><td>key</td><td>string</td><td>必须</td><td></td><td>["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name", "service_id"]</td><td>用来做请求计数的有效值。<br>例如,可以使用主机名(或服务器区域)作为关键字,以便限制每个主机名规定时间内的请求次数。我们也可以使用客户端地址作为关键字,这样我们就可以避免单个客户端规定时间内多次的连接我们的服务。<br>当前接受的 key 有:"remote_addr"(客户端IP地址), "server_addr"(服务端 IP 地址), 请求头中的"X-Forwarded-For" 或 "X-Real-IP", "consume [...] +<tr><td>key</td><td>string</td><td>可选</td><td>"remote_addr"</td><td>["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name", "service_id"]</td><td>用来做请求计数的有效值。<br>例如,可以使用主机名(或服务器区域)作为关键字,以便限制每个主机名规定时间内的请求次数。我们也可以使用客户端地址作为关键字,这样我们就可以避免单个客户端规定时间内多次的连接我们的服务。<br>当前接受的 key 有:"remote_addr"(客户端IP地址), "server_addr"(服务端 IP 地址), 请求头中的"X-Forwarded-For" 或 "X-Real- [...] <tr><td>rejected_code</td><td>integer</td><td>可选</td><td>503</td><td>[200,600]</td><td>当请求超过阈值被拒绝时,返回的 HTTP 状态码</td></tr> <tr><td>policy</td><td>string</td><td>可选</td><td>"local"</td><td>["local", "redis", "redis-cluster"]</td><td>用于检索和增加限制的速率限制策略。可选的值有:<code>local</code>(计数器被以内存方式保存在节点本地,默认选项) 和 <code>redis</code>(计数器保存在 Redis 服务节点上,从而可以跨节点共享结果,通常用它来完成全局限速);以及<code>redis-cluster</code>,跟redis功能一样,只是使用redis集群方式。</td></tr> <tr><td>redis_host</td><td>string</td><td><code>redis</code> 必须</td><td></td><td></td><td>当使用 <code>redis</code> 限速策略时,该属性是 Redis 服务节点的地址。</td></tr> diff --git a/apisix/zh-cn/plugins/limit-count/index.html b/apisix/zh-cn/plugins/limit-count/index.html index fcd1a6f..0d204f8 100644 --- a/apisix/zh-cn/plugins/limit-count/index.html +++ b/apisix/zh-cn/plugins/limit-count/index.html @@ -44,7 +44,7 @@ <tbody> <tr><td>count</td><td>integer</td><td>必须</td><td></td><td>[0,...]</td><td>指定时间窗口内的请求数量阈值</td></tr> <tr><td>time_window</td><td>integer</td><td>必须</td><td></td><td>[0,...]</td><td>时间窗口的大小(以秒为单位),超过这个时间就会重置</td></tr> -<tr><td>key</td><td>string</td><td>必须</td><td></td><td>["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name", "service_id"]</td><td>用来做请求计数的有效值。<br>例如,可以使用主机名(或服务器区域)作为关键字,以便限制每个主机名规定时间内的请求次数。我们也可以使用客户端地址作为关键字,这样我们就可以避免单个客户端规定时间内多次的连接我们的服务。<br>当前接受的 key 有:"remote_addr"(客户端IP地址), "server_addr"(服务端 IP 地址), 请求头中的"X-Forwarded-For" 或 "X-Real-IP", "consume [...] +<tr><td>key</td><td>string</td><td>可选</td><td>"remote_addr"</td><td>["remote_addr", "server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name", "service_id"]</td><td>用来做请求计数的有效值。<br>例如,可以使用主机名(或服务器区域)作为关键字,以便限制每个主机名规定时间内的请求次数。我们也可以使用客户端地址作为关键字,这样我们就可以避免单个客户端规定时间内多次的连接我们的服务。<br>当前接受的 key 有:"remote_addr"(客户端IP地址), "server_addr"(服务端 IP 地址), 请求头中的"X-Forwarded-For" 或 "X-Real- [...] <tr><td>rejected_code</td><td>integer</td><td>可选</td><td>503</td><td>[200,600]</td><td>当请求超过阈值被拒绝时,返回的 HTTP 状态码</td></tr> <tr><td>policy</td><td>string</td><td>可选</td><td>"local"</td><td>["local", "redis", "redis-cluster"]</td><td>用于检索和增加限制的速率限制策略。可选的值有:<code>local</code>(计数器被以内存方式保存在节点本地,默认选项) 和 <code>redis</code>(计数器保存在 Redis 服务节点上,从而可以跨节点共享结果,通常用它来完成全局限速);以及<code>redis-cluster</code>,跟redis功能一样,只是使用redis集群方式。</td></tr> <tr><td>redis_host</td><td>string</td><td><code>redis</code> 必须</td><td></td><td></td><td>当使用 <code>redis</code> 限速策略时,该属性是 Redis 服务节点的地址。</td></tr>