Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_api_module.xml @ 2691:5f961aa083db
Mentioned realip module in the listen directive for mail.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 23 Mar 2021 20:41:45 +0000 |
parents | 2b494b8ff72d |
children | 9dd8c203a54a |
rev | line source |
---|---|
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3 <!-- |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4 Copyright (C) Nginx, Inc. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
5 --> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
6 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
8 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
9 <module name="Module ngx_http_api_module" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
10 link="/en/docs/http/ngx_http_api_module.html" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
11 lang="en" |
2493
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
12 rev="3"> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
13 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
14 <section id="summary"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
15 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
16 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
17 The <literal>ngx_http_api_module</literal> module (1.13.3) provides REST API |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
18 for accessing various status information, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
19 configuring upstream server groups on-the-fly, and managing |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
20 <link doc="ngx_http_keyval_module.xml">key-value pairs</link> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
21 without the need of reconfiguring nginx. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
22 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
23 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
24 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
25 <note> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
26 The module supersedes the |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
27 <link doc="ngx_http_status_module.xml">ngx_http_status_module</link> and |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
28 <link doc="ngx_http_upstream_conf_module.xml">ngx_http_upstream_conf_module</link> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
29 modules. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
30 </note> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
31 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
32 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
33 <para> |
2493
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
34 When using the <literal>PATCH</literal> or <literal>POST</literal> methods, |
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
35 make sure that the payload does not exceed the |
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
36 <link doc="ngx_http_core_module.xml" id="client_body_buffer_size">buffer size</link> |
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
37 for reading the client request body, otherwise, the |
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
38 <http-status code="413" text="Request Entity Too Large"/> |
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
39 error may be returned. |
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
40 </para> |
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
41 |
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
42 <para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
43 <note> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
44 This module is available as part of our |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
45 <commercial_version>commercial subscription</commercial_version>. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
46 </note> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
47 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
48 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
49 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
50 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
51 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
52 <section id="example" name="Example Configuration"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
53 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
54 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
55 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
56 http { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
57 upstream backend { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
58 zone http_backend 64k; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
59 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
60 server backend1.example.com weight=5; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
61 server backend2.example.com; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
62 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
63 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
64 proxy_cache_path /data/nginx/cache_backend keys_zone=cache_backend:10m; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
65 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
66 server { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
67 server_name backend.example.com; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
68 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
69 location / { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
70 proxy_pass http://backend; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
71 proxy_cache cache_backend; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
72 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
73 health_check; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
74 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
75 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
76 status_zone server_backend; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
77 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
78 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
79 keyval_zone zone=one:32k state=one.keyval; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
80 keyval $arg_text $text zone=one; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
81 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
82 server { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
83 listen 127.0.0.1; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
84 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
85 location /api { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
86 <emphasis>api</emphasis> write=on; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
87 allow 127.0.0.1; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
88 deny all; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
89 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
90 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
91 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
92 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
93 stream { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
94 upstream backend { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
95 zone stream_backend 64k; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
96 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
97 server backend1.example.com:12345 weight=5; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
98 server backend2.example.com:12345; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
99 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
100 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
101 server { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
102 listen 127.0.0.1:12345; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
103 proxy_pass backend; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
104 status_zone server_backend; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
105 health_check; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
106 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
107 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
108 </example> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
109 All API requests include |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
110 a supported API <link id="api_version">version</link> in the URI. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
111 Examples of API requests with this configuration: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
112 <example> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
113 http://127.0.0.1/api/6/ |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
114 http://127.0.0.1/api/6/nginx |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
115 http://127.0.0.1/api/6/connections |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
116 http://127.0.0.1/api/6/http/requests |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
117 http://127.0.0.1/api/6/http/server_zones/server_backend |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
118 http://127.0.0.1/api/6/http/caches/cache_backend |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
119 http://127.0.0.1/api/6/http/upstreams/backend |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
120 http://127.0.0.1/api/6/http/upstreams/backend/servers/ |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
121 http://127.0.0.1/api/6/http/upstreams/backend/servers/1 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
122 http://127.0.0.1/api/6/http/keyvals/one?key=arg1 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
123 http://127.0.0.1/api/6/stream/ |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
124 http://127.0.0.1/api/6/stream/server_zones/server_backend |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
125 http://127.0.0.1/api/6/stream/upstreams/ |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
126 http://127.0.0.1/api/6/stream/upstreams/backend |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
127 http://127.0.0.1/api/6/stream/upstreams/backend/servers/1 |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
128 </example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
129 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
130 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
131 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
132 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
133 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
134 <section id="directives" name="Directives"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
135 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
136 <directive name="api"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
137 <syntax> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
138 [<literal>write</literal>=<literal>on</literal>|<literal>off</literal>]</syntax> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
139 <default/> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
140 <context>location</context> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
141 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
142 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
143 Turns on the REST API interface in the surrounding location. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
144 Access to this location should be |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
145 <link doc="ngx_http_core_module.xml" id="satisfy">limited</link>. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
146 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
147 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
148 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
149 The <literal>write</literal> parameter determines whether the API |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
150 is read-only or read-write. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
151 By default, the API is read-only. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
152 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
153 |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
154 <para id="api_version"> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
155 All API requests should contain a supported API version in the URI. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
156 If the request URI equals the location prefix, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
157 the list of supported API versions is returned. |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
158 The current API version is “<literal>6</literal>”. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
159 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
160 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
161 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
162 The optional “<literal>fields</literal>” argument in the request line |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
163 specifies which fields of the requested objects will be output: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
164 <example> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
165 http://127.0.0.1/api/6/nginx?fields=version,build |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
166 </example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
167 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
168 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
169 </directive> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
170 |
2221
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
171 |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
172 <directive name="status_zone"> |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
173 <syntax><value>zone</value></syntax> |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
174 <default/> |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
175 <context>server</context> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
176 <context>location</context> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
177 <context>if in location</context> |
2221
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
178 <appeared-in>1.13.12</appeared-in> |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
179 |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
180 <para> |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
181 Enables collection of virtual |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
182 <link doc="ngx_http_core_module.xml" id="server">http</link> |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
183 or |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
184 <link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link> |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
185 server status information in the specified <value>zone</value>. |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
186 Several servers may share the same zone. |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
187 </para> |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
188 |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
189 <para id="status_zone_location"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
190 Starting from 1.17.0, status information can be collected |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
191 per <link doc="ngx_http_core_module.xml" id="location"/>. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
192 The special value <literal>off</literal> disables statistics collection |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
193 in nested location blocks. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
194 Note that the statistics is collected |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
195 in the context of a location where processing ends. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
196 It may be different from the original location, if an |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
197 <link doc="ngx_http_core_module.xml" id="internal">internal |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
198 redirect</link> happens during request processing. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
199 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
200 |
2221
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
201 </directive> |
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
202 |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
203 </section> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
204 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
205 <section id="compatibility" name="Compatibility"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
206 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
207 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
208 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
209 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
210 <listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
211 The <link id="stream_limit_conns_">/stream/limit_conns/</link> data |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
212 were added in <link id="api_version">version</link> 6. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
213 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
214 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
215 <listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
216 The <link id="http_limit_conns_">/http/limit_conns/</link> data |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
217 were added in <link id="api_version">version</link> 6. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
218 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
219 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
220 <listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
221 The <link id="http_limit_reqs_">/http/limit_reqs/</link> data |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
222 were added in <link id="api_version">version</link> 6. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
223 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
224 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
225 <listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
226 The “<literal>expire</literal>” parameter of a |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
227 <link doc="ngx_http_keyval_module.xml">key-value</link> pair can be |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
228 <link id="postHttpKeyvalZoneData">set</link> or |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
229 <link id="patchHttpKeyvalZoneKeyValue">changed</link> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
230 since <link id="api_version">version</link> 5. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
231 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
232 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
233 <listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
234 The <link id="resolvers_">/resolvers/</link> data |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
235 were added in <link id="api_version">version</link> 5. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
236 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
237 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
238 <listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
239 The <link id="http_location_zones_">/http/location_zones/</link> data |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
240 were added in <link id="api_version">version</link> 5. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
241 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
242 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
243 <listitem> |
2359
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
244 The <literal>path</literal> and <literal>method</literal> fields of |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
245 <link id="def_nginx_error">nginx error object</link> |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
246 were removed in <link id="api_version">version</link> 4. |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
247 These fields continue to exist in earlier api versions, |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
248 but show an empty value. |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
249 </listitem> |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
250 |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
251 <listitem> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
252 The <link id="stream_zone_sync_">/stream/zone_sync/</link> data |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
253 were added in <link id="api_version">version</link> 3. |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
254 </listitem> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
255 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
256 <listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
257 The <link id="def_nginx_http_upstream_conf_server">drain</link> parameter |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
258 was added in <link id="api_version">version</link> 2. |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
259 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
260 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
261 <listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
262 The <link id="stream_keyvals_">/stream/keyvals/</link> data |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
263 were added in <link id="api_version">version</link> 2. |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
264 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
265 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
266 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
267 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
268 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
269 </section> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
270 <section id="endpoints" name="Endpoints"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
271 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
272 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
273 <tag-name id="root" name="/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
274 <literal>/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
275 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
276 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
277 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
278 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
279 <listitem id="getAPIEndpoints"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
280 <literal>GET</literal> - Return list of root endpoints |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
281 <para>Returns a list of root endpoints.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
282 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
283 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
284 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
285 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
286 <listitem>200 - Success, returns an array of strings</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
287 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
288 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
289 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
290 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
291 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
292 <tag-name id="nginx" name="/nginx"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
293 <literal>/nginx</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
294 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
295 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
296 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
297 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
298 <listitem id="getNginx"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
299 <literal>GET</literal> - Return status of nginx running instance |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
300 <para>Returns nginx version, build name, address, number of configuration reloads, IDs of master and worker processes.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
301 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
302 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
303 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
304 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
305 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
306 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
307 Limits which fields of nginx running instance will be output.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
308 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
309 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
310 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
311 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
312 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
313 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
314 <listitem>200 - Success, returns <link id="def_nginx_object">nginx</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
315 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
316 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
317 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
318 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
319 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
320 <tag-name id="processes" name="/processes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
321 <literal>/processes</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
322 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
323 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
324 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
325 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
326 <listitem id="getProcesses"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
327 <literal>GET</literal> - Return nginx processes status |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
328 <para>Returns the number of abnormally terminated and respawned child processes.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
329 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
330 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
331 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
332 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
333 <listitem>200 - Success, returns <link id="def_nginx_processes">Processes</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
334 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
335 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
336 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
337 <listitem id="deleteProcesses"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
338 <literal>DELETE</literal> - Reset nginx processes statistics |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
339 <para>Resets counters of abnormally terminated and respawned child processes.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
340 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
341 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
342 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
343 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
344 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
345 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2500
8a9b2efa92aa
Documented the "Method disabled" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2499
diff
changeset
|
346 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
347 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
348 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
349 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
350 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
351 <tag-name id="connections" name="/connections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
352 <literal>/connections</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
353 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
354 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
355 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
356 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
357 <listitem id="getConnections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
358 <literal>GET</literal> - Return client connections statistics |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
359 <para>Returns statistics of client connections.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
360 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
361 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
362 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
363 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
364 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
365 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
366 Limits which fields of the connections statistics will be output.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
367 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
368 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
369 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
370 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
371 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
372 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
373 <listitem>200 - Success, returns <link id="def_nginx_connections">Connections</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
374 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
375 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
376 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
377 <listitem id="deleteConnections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
378 <literal>DELETE</literal> - Reset client connections statistics |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
379 <para>Resets statistics of accepted and dropped client connections.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
380 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
381 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
382 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
383 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
384 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
385 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2500
8a9b2efa92aa
Documented the "Method disabled" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2499
diff
changeset
|
386 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
387 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
388 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
389 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
390 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
391 <tag-name id="slabs_" name="/slabs/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
392 <literal>/slabs/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
393 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
394 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
395 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
396 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
397 <listitem id="getSlabs"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
398 <literal>GET</literal> - Return status of all slabs |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
399 <para>Returns status of slabs for each shared memory zone with slab allocator.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
400 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
401 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
402 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
403 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
404 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
405 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
406 Limits which fields of slab zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
407 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
408 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
409 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
410 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
411 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
412 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
413 <listitem>200 - Success, returns a collection of "<link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link>" objects for all slabs</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
414 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
415 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
416 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
417 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
418 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
419 <tag-name id="slabs_slab_zone_name" name="/slabs/{slabZoneName}"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
420 <literal>/slabs/{slabZoneName}</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
421 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
422 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
423 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
424 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
425 <tag-name><literal>slabZoneName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
426 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
427 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
428 The name of the shared memory zone with slab allocator.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
429 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
430 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
431 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
432 <listitem id="getSlabZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
433 <literal>GET</literal> - Return status of a slab |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
434 <para>Returns status of slabs for a particular shared memory zone with slab allocator.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
435 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
436 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
437 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
438 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
439 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
440 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
441 Limits which fields of the slab zone will be output.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
442 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
443 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
444 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
445 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
446 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
447 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
448 <listitem>200 - Success, returns <link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
449 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
450 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
451 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
452 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
453 <listitem id="deleteSlabZoneStats"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
454 <literal>DELETE</literal> - Reset slab statistics |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
455 <para>Resets the “<literal>reqs</literal>” and “<literal>fails</literal>” metrics for each memory slot.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
456 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
457 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
458 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
459 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
460 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
461 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
462 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
463 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
464 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
465 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
466 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
467 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
468 <tag-name id="http_" name="/http/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
469 <literal>/http/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
470 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
471 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
472 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
473 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
474 <listitem id="getHttp"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
475 <literal>GET</literal> - Return list of HTTP-related endpoints |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
476 <para>Returns a list of first level HTTP endpoints.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
477 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
478 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
479 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
480 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
481 <listitem>200 - Success, returns an array of strings</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
482 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
483 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
484 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
485 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
486 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
487 <tag-name id="http_requests" name="/http/requests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
488 <literal>/http/requests</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
489 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
490 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
491 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
492 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
493 <listitem id="getHttpRequests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
494 <literal>GET</literal> - Return HTTP requests statistics |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
495 <para>Returns status of client HTTP requests.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
496 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
497 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
498 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
499 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
500 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
501 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
502 Limits which fields of client HTTP requests statistics will be output.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
503 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
504 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
505 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
506 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
507 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
508 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
509 <listitem>200 - Success, returns <link id="def_nginx_http_requests">HTTP Requests</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
510 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
511 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
512 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
513 <listitem id="deleteHttpRequests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
514 <literal>DELETE</literal> - Reset HTTP requests statistics |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
515 <para>Resets the number of total client HTTP requests.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
516 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
517 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
518 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
519 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
520 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
521 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
522 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
523 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
524 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
525 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
526 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
527 <tag-name id="http_server_zones_" name="/http/server_zones/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
528 <literal>/http/server_zones/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
529 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
530 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
531 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
532 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
533 <listitem id="getHttpServerZones"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
534 <literal>GET</literal> - Return status of all HTTP server zones |
2221
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
535 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">server zone</link>.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
536 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
537 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
538 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
539 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
540 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
541 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
542 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names will be output.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
543 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
544 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
545 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
546 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
547 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
548 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
549 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_server_zone">HTTP Server Zone</link>" objects for all HTTP server zones</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
550 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
551 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
552 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
553 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
554 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
555 <tag-name id="http_server_zones_http_server_zone_name" name="/http/server_zones/{httpServerZoneName}"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
556 <literal>/http/server_zones/{httpServerZoneName}</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
557 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
558 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
559 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
560 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
561 <tag-name><literal>httpServerZoneName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
562 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
563 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
564 The name of an HTTP server zone.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
565 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
566 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
567 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
568 <listitem id="getHttpServerZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
569 <literal>GET</literal> - Return status of an HTTP server zone |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
570 <para>Returns status of a particular HTTP server zone.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
571 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
572 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
573 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
574 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
575 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
576 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
577 Limits which fields of the server zone will be output.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
578 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
579 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
580 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
581 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
582 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
583 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
584 <listitem>200 - Success, returns <link id="def_nginx_http_server_zone">HTTP Server Zone</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
585 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
586 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
587 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
588 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
589 <listitem id="deleteHttpServerZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
590 <literal>DELETE</literal> - Reset statistics for an HTTP server zone |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
591 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular HTTP server zone.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
592 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
593 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
594 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
595 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
596 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
597 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
598 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
599 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
600 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
601 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
602 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
603 </tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
604 <tag-name id="http_location_zones_" name="/http/location_zones/"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
605 <literal>/http/location_zones/</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
606 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
607 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
608 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
609 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
610 <listitem id="getHttpLocationZones"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
611 <literal>GET</literal> - Return status of all HTTP location zones |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
612 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
613 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
614 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
615 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
616 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
617 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
618 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
619 Limits which fields of location zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
620 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
621 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
622 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
623 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
624 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
625 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
626 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_location_zone">HTTP Location Zone</link>" objects for all HTTP location zones</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
627 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
628 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
629 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
630 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
631 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
632 <tag-name id="http_location_zones_http_location_zone_name" name="/http/location_zones/{httpLocationZoneName}"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
633 <literal>/http/location_zones/{httpLocationZoneName}</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
634 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
635 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
636 Parameters common for all methods: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
637 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
638 <tag-name><literal>httpLocationZoneName</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
639 (<literal>string</literal>, required)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
640 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
641 The name of an HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
642 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
643 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
644 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
645 <listitem id="getHttpLocationZone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
646 <literal>GET</literal> - Return status of an HTTP location zone |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
647 <para>Returns status of a particular HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
648 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
649 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
650 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
651 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
652 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
653 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
654 Limits which fields of the location zone will be output.</tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
655 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
656 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
657 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
658 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
659 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
660 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
661 <listitem>200 - Success, returns <link id="def_nginx_http_location_zone">HTTP Location Zone</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
662 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
663 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
664 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
665 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
666 <listitem id="deleteHttpLocationZoneStat"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
667 <literal>DELETE</literal> - Reset statistics for a location zone. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
668 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular location zone.</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
669 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
670 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
671 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
672 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
673 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
674 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
675 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
676 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
677 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
678 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
679 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
680 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
681 <tag-name id="http_caches_" name="/http/caches/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
682 <literal>/http/caches/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
683 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
684 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
685 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
686 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
687 <listitem id="getHttpCaches"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
688 <literal>GET</literal> - Return status of all caches |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
689 <para>Returns status of each cache configured by <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path">proxy_cache_path</link> and other “<literal>*_cache_path</literal>” directives.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
690 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
691 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
692 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
693 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
694 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
695 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
696 Limits which fields of cache zones will be output. If the “<literal>fields</literal>” value is empty, then only names of cache zones will be output.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
697 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
698 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
699 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
700 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
701 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
702 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
703 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_cache">HTTP Cache</link>" objects for all HTTP caches</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
704 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
705 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
706 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
707 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
708 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
709 <tag-name id="http_caches_http_cache_zone_name" name="/http/caches/{httpCacheZoneName}"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
710 <literal>/http/caches/{httpCacheZoneName}</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
711 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
712 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
713 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
714 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
715 <tag-name><literal>httpCacheZoneName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
716 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
717 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
718 The name of the cache zone.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
719 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
720 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
721 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
722 <listitem id="getHttpCacheZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
723 <literal>GET</literal> - Return status of a cache |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
724 <para>Returns status of a particular cache.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
725 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
726 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
727 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
728 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
729 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
730 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
731 Limits which fields of the cache zone will be output.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
732 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
733 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
734 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
735 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
736 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
737 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
738 <listitem>200 - Success, returns <link id="def_nginx_http_cache">HTTP Cache</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
739 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
740 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
741 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
742 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
743 <listitem id="deleteHttpCacheZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
744 <literal>DELETE</literal> - Reset cache statistics |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
745 <para>Resets statistics of cache hits/misses in a particular cache zone.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
746 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
747 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
748 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
749 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
750 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
751 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
752 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
753 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
754 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
755 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
756 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
757 </tag-desc> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
758 <tag-name id="http_limit_conns_" name="/http/limit_conns/"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
759 <literal>/http/limit_conns/</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
760 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
761 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
762 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
763 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
764 <listitem id="getHttpLimitConnZones"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
765 <literal>GET</literal> - Return status of all HTTP limit_conn zones |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
766 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
767 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
768 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
769 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
770 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
771 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
772 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
773 Limits which fields of limit_conn zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
774 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
775 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
776 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
777 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
778 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
779 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
780 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link>" objects for all HTTP limit conns</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
781 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
782 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
783 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
784 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
785 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
786 <tag-name id="http_limit_conns_http_limit_conn_zone_name" name="/http/limit_conns/{httpLimitConnZoneName}"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
787 <literal>/http/limit_conns/{httpLimitConnZoneName}</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
788 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
789 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
790 Parameters common for all methods: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
791 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
792 <tag-name><literal>httpLimitConnZoneName</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
793 (<literal>string</literal>, required)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
794 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
795 The name of a <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
796 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
797 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
798 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
799 <listitem id="getHttpLimitConnZone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
800 <literal>GET</literal> - Return status of an HTTP limit_conn zone |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
801 <para>Returns status of a particular HTTP <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
802 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
803 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
804 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
805 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
806 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
807 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
808 Limits which fields of the <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</link> will be output.</tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
809 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
810 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
811 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
812 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
813 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
814 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
815 <listitem>200 - Success, returns <link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
816 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
817 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
818 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
819 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
820 <listitem id="deleteHttpLimitConnZoneStat"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
821 <literal>DELETE</literal> - Reset statistics for an HTTP limit_conn zone |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
822 <para>Resets the connection limiting statistics.</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
823 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
824 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
825 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
826 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
827 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
828 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
829 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
830 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
831 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
832 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
833 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
834 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
835 <tag-name id="http_limit_reqs_" name="/http/limit_reqs/"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
836 <literal>/http/limit_reqs/</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
837 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
838 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
839 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
840 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
841 <listitem id="getHttpLimitReqZones"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
842 <literal>GET</literal> - Return status of all HTTP limit_req zones |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
843 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</link>.</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
844 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
845 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
846 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
847 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
848 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
849 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
850 Limits which fields of limit_req zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
851 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
852 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
853 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
854 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
855 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
856 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
857 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link>" objects for all HTTP limit reqs</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
858 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
859 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
860 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
861 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
862 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
863 <tag-name id="http_limit_reqs_http_limit_req_zone_name" name="/http/limit_reqs/{httpLimitReqZoneName}"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
864 <literal>/http/limit_reqs/{httpLimitReqZoneName}</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
865 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
866 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
867 Parameters common for all methods: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
868 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
869 <tag-name><literal>httpLimitReqZoneName</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
870 (<literal>string</literal>, required)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
871 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
872 The name of a <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</link>.</tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
873 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
874 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
875 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
876 <listitem id="getHttpLimitReqZone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
877 <literal>GET</literal> - Return status of an HTTP limit_req zone |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
878 <para>Returns status of a particular HTTP <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</link>.</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
879 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
880 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
881 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
882 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
883 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
884 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
885 Limits which fields of the <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</link> will be output.</tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
886 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
887 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
888 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
889 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
890 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
891 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
892 <listitem>200 - Success, returns <link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
893 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
894 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
895 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
896 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
897 <listitem id="deleteHttpLimitReqZoneStat"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
898 <literal>DELETE</literal> - Reset statistics for an HTTP limit_req zone |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
899 <para>Resets the requests limiting statistics.</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
900 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
901 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
902 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
903 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
904 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
905 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
906 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
907 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
908 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
909 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
910 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
911 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
912 <tag-name id="http_upstreams_" name="/http/upstreams/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
913 <literal>/http/upstreams/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
914 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
915 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
916 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
917 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
918 <listitem id="getHttpUpstreams"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
919 <literal>GET</literal> - Return status of all HTTP upstream server groups |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
920 <para>Returns status of each HTTP upstream server group and its servers.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
921 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
922 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
923 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
924 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
925 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
926 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
927 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams will be output.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
928 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
929 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
930 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
931 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
932 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
933 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
934 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_upstream">HTTP Upstream</link>" objects for all HTTP upstreams</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
935 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
936 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
937 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
938 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
939 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
940 <tag-name id="http_upstreams_http_upstream_name_" name="/http/upstreams/{httpUpstreamName}/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
941 <literal>/http/upstreams/{httpUpstreamName}/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
942 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
943 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
944 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
945 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
946 <tag-name><literal>httpUpstreamName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
947 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
948 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
949 The name of an HTTP upstream server group.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
950 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
951 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
952 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
953 <listitem id="getHttpUpstreamName"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
954 <literal>GET</literal> - Return status of an HTTP upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
955 <para>Returns status of a particular HTTP upstream server group and its servers.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
956 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
957 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
958 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
959 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
960 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
961 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
962 Limits which fields of the upstream server group will be output.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
963 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
964 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
965 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
966 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
967 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
968 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
969 <listitem>200 - Success, returns <link id="def_nginx_http_upstream">HTTP Upstream</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
970 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
971 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
972 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
973 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
974 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
975 <listitem id="deleteHttpUpstreamStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
976 <literal>DELETE</literal> - Reset statistics of an HTTP upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
977 <para>Resets the statistics for each upstream server in an upstream server group and queue statistics.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
978 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
979 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
980 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
981 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
982 <listitem>204 - Success</listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
983 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
984 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
985 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
986 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
987 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
988 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
989 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
990 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
991 <tag-name id="http_upstreams_http_upstream_name_servers_" name="/http/upstreams/{httpUpstreamName}/servers/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
992 <literal>/http/upstreams/{httpUpstreamName}/servers/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
993 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
994 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
995 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
996 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
997 <tag-name><literal>httpUpstreamName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
998 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
999 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1000 The name of an upstream server group.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1001 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1002 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1003 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1004 <listitem id="getHttpUpstreamServers"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1005 <literal>GET</literal> - Return configuration of all servers in an HTTP upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1006 <para>Returns configuration of each server in a particular HTTP upstream server group.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1007 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1008 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1009 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1010 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1011 <listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1012 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1013 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1014 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1015 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1016 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1017 <listitem id="postHttpUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1018 <literal>POST</literal> - Add a server to an HTTP upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1019 <para>Adds a new server to an HTTP upstream server group. Server parameters are specified in the JSON format.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1020 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1021 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1022 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1023 <tag-name><literal>postHttpUpstreamServer</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1024 (<link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1025 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1026 Address of a new server and other optional parameters in the JSON format. The “<literal>ID</literal>”, “<literal>backup</literal>”, and “<literal>service</literal>” parameters cannot be changed.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1027 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1028 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1029 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1030 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1031 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1032 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1033 <listitem>201 - Created, returns <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1034 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1035 invalid “<value>parameter</value>” value (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1036 missing “<literal>server</literal>” argument (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1037 unknown parameter “<value>name</value>” (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1038 nested object or list (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1039 “<literal>error</literal>” while parsing (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1040 service upstream “<literal>host</literal>” may not have port (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1041 service upstream “<literal>host</literal>” requires domain name (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1042 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1043 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1044 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1045 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1046 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1047 reading request body failed <literal>BodyReadError</literal>), |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1048 route is too long (<literal>UpstreamBadRoute</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1049 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1050 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1051 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1052 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1053 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1054 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1055 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2501
2b494b8ff72d
Documented the "Entry exists" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2500
diff
changeset
|
1056 <listitem>409 - Entry exists (<literal>EntryExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1057 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1058 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1059 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1060 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1061 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1062 <tag-name id="http_upstreams_http_upstream_name_servers_http_upstream_server_id" name="/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1063 <literal>/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1064 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1065 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1066 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1067 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1068 <tag-name><literal>httpUpstreamName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1069 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1070 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1071 The name of the upstream server group.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1072 <tag-name><literal>httpUpstreamServerId</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1073 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1074 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1075 The ID of the server.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1076 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1077 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1078 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1079 <listitem id="getHttpUpstreamPeer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1080 <literal>GET</literal> - Return configuration of a server in an HTTP upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1081 <para>Returns configuration of a particular server in the HTTP upstream server group.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1082 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1083 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1084 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1085 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1086 <listitem>200 - Success, returns <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1087 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1088 invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1089 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1090 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1091 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1092 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1093 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1094 <listitem id="patchHttpUpstreamPeer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1095 <literal>PATCH</literal> - Modify a server in an HTTP upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1096 <para>Modifies settings of a particular server in an HTTP upstream server group. Server parameters are specified in the JSON format.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1097 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1098 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1099 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1100 <tag-name><literal>patchHttpUpstreamServer</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1101 (<link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1102 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1103 Server parameters, specified in the JSON format. The “<literal>ID</literal>”, “<literal>backup</literal>”, and “<literal>service</literal>” parameters cannot be changed.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1104 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1105 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1106 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1107 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1108 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1109 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1110 <listitem>200 - Success, returns <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1111 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1112 invalid “<value>parameter</value>” value (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1113 unknown parameter “<value>name</value>” (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1114 nested object or list (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1115 “<literal>error</literal>” while parsing (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1116 invalid “<literal>server</literal>” argument (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1117 invalid server ID (<literal>UpstreamBadServerId</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1118 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1119 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1120 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1121 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1122 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1123 reading request body failed <literal>BodyReadError</literal>), |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1124 route is too long (<literal>UpstreamBadRoute</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1125 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1126 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1127 server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1128 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1129 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1130 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1131 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1132 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1133 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1134 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1135 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1136 <listitem id="deleteHttpUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1137 <literal>DELETE</literal> - Remove a server from an HTTP upstream server group |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1138 <para>Removes a server from an HTTP upstream server group.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1139 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1140 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1141 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1142 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1143 <listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1144 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1145 invalid server ID (<literal>UpstreamBadServerId</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1146 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1147 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1148 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1149 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1150 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1151 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1152 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1153 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1154 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1155 <tag-name id="http_keyvals_" name="/http/keyvals/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1156 <literal>/http/keyvals/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1157 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1158 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1159 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1160 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1161 <listitem id="getHttpKeyvalZones"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1162 <literal>GET</literal> - Return key-value pairs from all HTTP keyval zones |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1163 <para>Returns key-value pairs for each HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1164 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1165 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1166 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1167 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1168 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1169 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1170 If the “<literal>fields</literal>” value is empty, then only HTTP keyval zone names will be output.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1171 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1172 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1173 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1174 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1175 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1176 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1177 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link>" objects for all HTTP keyvals</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1178 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1179 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1180 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1181 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1182 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1183 <tag-name id="http_keyvals_http_keyval_zone_name" name="/http/keyvals/{httpKeyvalZoneName}"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1184 <literal>/http/keyvals/{httpKeyvalZoneName}</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1185 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1186 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1187 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1188 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1189 <tag-name><literal>httpKeyvalZoneName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1190 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1191 <tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1192 The name of an HTTP keyval shared memory zone.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1193 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1194 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1195 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1196 <listitem id="getHttpKeyvalZoneKeysValues"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1197 <literal>GET</literal> - Return key-value pairs from an HTTP keyval zone |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1198 <para>Returns key-value pairs stored in a particular HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1199 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1200 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1201 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1202 <tag-name><literal>key</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1203 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1204 <tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1205 Get a particular key-value pair from the HTTP keyval zone.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1206 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1207 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1208 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1209 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1210 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1211 <list type="bullet"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1212 <listitem>200 - Success, returns <link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1213 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1214 keyval key not found (<literal>KeyvalKeyNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1215 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1216 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1217 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1218 <listitem id="postHttpKeyvalZoneData"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1219 <literal>POST</literal> - Add a key-value pair to the HTTP keyval zone |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1220 <para>Adds a new key-value pair to the HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1221 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1222 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1223 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1224 <tag-name><literal>Key-value</literal> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1225 (<link id="def_nginx_http_keyval_zone_post_patch">HTTP Keyval Shared Memory Zone</link>, required)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1226 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1227 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</link> directive.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1228 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1229 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1230 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1231 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1232 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1233 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1234 <listitem>201 - Created</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1235 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1236 invalid key format (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1237 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1238 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1239 only one key can be added (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1240 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1241 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1242 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1243 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2501
2b494b8ff72d
Documented the "Entry exists" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2500
diff
changeset
|
1244 <listitem>409 - Entry exists (<literal>EntryExists</literal>), |
2b494b8ff72d
Documented the "Entry exists" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2500
diff
changeset
|
1245 key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2493
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
1246 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1247 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1248 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1249 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1250 <listitem id="patchHttpKeyvalZoneKeyValue"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1251 <literal>PATCH</literal> - Modify a key-value or delete a key |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1252 <para>Changes the value of the selected key in the key-value pair, deletes a key by setting the key value to <literal>null</literal>, changes expiration time of a key-value pair. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</link> directive.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1253 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1254 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1255 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1256 <tag-name><literal>httpKeyvalZoneKeyValue</literal> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1257 (<link id="def_nginx_http_keyval_zone_post_patch">HTTP Keyval Shared Memory Zone</link>, required)</tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1258 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1259 A new value for the key is specified in the JSON format.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1260 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1261 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1262 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1263 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1264 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1265 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1266 <listitem>204 - Success</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1267 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1268 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1269 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1270 only one key can be updated (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1271 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1272 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1273 keyval key not found (<literal>KeyvalKeyNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1274 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1275 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2493
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
1276 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1277 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1278 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1279 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1280 <listitem id="deleteHttpKeyvalZoneData"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1281 <literal>DELETE</literal> - Empty the HTTP keyval zone |
2359
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
1282 <para>Deletes all key-value pairs from the HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, empties the keyval zone only on a target cluster node.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1283 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1284 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1285 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1286 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1287 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1288 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1289 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1290 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1291 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1292 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1293 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1294 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1295 <tag-name id="stream_" name="/stream/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1296 <literal>/stream/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1297 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1298 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1299 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1300 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1301 <listitem id="getStream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1302 <literal>GET</literal> - Return list of stream-related endpoints |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1303 <para>Returns a list of first level stream endpoints.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1304 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1305 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1306 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1307 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1308 <listitem>200 - Success, returns an array of strings</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1309 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1310 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1311 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1312 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1313 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1314 <tag-name id="stream_server_zones_" name="/stream/server_zones/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1315 <literal>/stream/server_zones/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1316 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1317 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1318 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1319 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1320 <listitem id="getStreamServerZones"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1321 <literal>GET</literal> - Return status of all stream server zones |
2221
45a2b90247ad
Added "status_zone" to the API module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2139
diff
changeset
|
1322 <para>Returns status information for each stream <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">server zone</link>.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1323 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1324 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1325 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1326 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1327 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1328 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1329 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names will be output.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1330 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1331 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1332 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1333 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1334 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1335 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1336 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_server_zone">Stream Server Zone</link>" objects for all stream server zones</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1337 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1338 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1339 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1340 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1341 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1342 <tag-name id="stream_server_zones_stream_server_zone_name" name="/stream/server_zones/{streamServerZoneName}"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1343 <literal>/stream/server_zones/{streamServerZoneName}</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1344 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1345 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1346 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1347 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1348 <tag-name><literal>streamServerZoneName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1349 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1350 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1351 The name of a stream server zone.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1352 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1353 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1354 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1355 <listitem id="getStreamServerZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1356 <literal>GET</literal> - Return status of a stream server zone |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1357 <para>Returns status of a particular stream server zone.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1358 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1359 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1360 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1361 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1362 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1363 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1364 Limits which fields of the server zone will be output.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1365 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1366 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1367 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1368 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1369 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1370 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1371 <listitem>200 - Success, returns <link id="def_nginx_stream_server_zone">Stream Server Zone</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1372 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1373 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1374 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1375 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1376 <listitem id="deleteStreamServerZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1377 <literal>DELETE</literal> - Reset statistics for a stream server zone |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1378 <para>Resets statistics of accepted and discarded connections, sessions, received and sent bytes in a particular stream server zone.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1379 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1380 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1381 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1382 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1383 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1384 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1385 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1386 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1387 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1388 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1389 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1390 </tag-desc> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1391 <tag-name id="stream_limit_conns_" name="/stream/limit_conns/"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1392 <literal>/stream/limit_conns/</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1393 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1394 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1395 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1396 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1397 <listitem id="getStreamLimitConnZones"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1398 <literal>GET</literal> - Return status of all stream limit_conn zones |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1399 <para>Returns status information for each stream <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1400 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1401 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1402 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1403 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1404 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1405 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1406 Limits which fields of limit_conn zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1407 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1408 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1409 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1410 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1411 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1412 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1413 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link>" objects for all stream limit conns</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1414 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1415 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1416 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1417 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1418 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1419 <tag-name id="stream_limit_conns_stream_limit_conn_zone_name" name="/stream/limit_conns/{streamLimitConnZoneName}"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1420 <literal>/stream/limit_conns/{streamLimitConnZoneName}</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1421 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1422 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1423 Parameters common for all methods: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1424 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1425 <tag-name><literal>streamLimitConnZoneName</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1426 (<literal>string</literal>, required)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1427 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1428 The name of a <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1429 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1430 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1431 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1432 <listitem id="getStreamLimitConnZone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1433 <literal>GET</literal> - Return status of an stream limit_conn zone |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1434 <para>Returns status of a particular stream <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1435 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1436 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1437 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1438 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1439 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1440 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1441 Limits which fields of the <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</link> will be output.</tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1442 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1443 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1444 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1445 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1446 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1447 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1448 <listitem>200 - Success, returns <link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1449 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1450 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1451 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1452 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1453 <listitem id="deleteStreamLimitConnZoneStat"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1454 <literal>DELETE</literal> - Reset statistics for a stream limit_conn zone |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1455 <para>Resets the connection limiting statistics.</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1456 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1457 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1458 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1459 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1460 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1461 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1462 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1463 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1464 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1465 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1466 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1467 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1468 <tag-name id="stream_upstreams_" name="/stream/upstreams/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1469 <literal>/stream/upstreams/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1470 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1471 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1472 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1473 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1474 <listitem id="getStreamUpstreams"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1475 <literal>GET</literal> - Return status of all stream upstream server groups |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1476 <para>Returns status of each stream upstream server group and its servers.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1477 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1478 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1479 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1480 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1481 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1482 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1483 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams will be output.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1484 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1485 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1486 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1487 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1488 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1489 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1490 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1491 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1492 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1493 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1494 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1495 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1496 <tag-name id="stream_upstreams_stream_upstream_name_" name="/stream/upstreams/{streamUpstreamName}/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1497 <literal>/stream/upstreams/{streamUpstreamName}/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1498 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1499 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1500 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1501 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1502 <tag-name><literal>streamUpstreamName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1503 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1504 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1505 The name of a stream upstream server group.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1506 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1507 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1508 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1509 <listitem id="getStreamUpstream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1510 <literal>GET</literal> - Return status of a stream upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1511 <para>Returns status of a particular stream upstream server group and its servers.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1512 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1513 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1514 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1515 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1516 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1517 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1518 Limits which fields of the upstream server group will be output.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1519 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1520 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1521 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1522 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1523 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1524 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1525 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream">Stream Upstream</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1526 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1527 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1528 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1529 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1530 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1531 <listitem id="deleteStreamUpstreamStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1532 <literal>DELETE</literal> - Reset statistics of a stream upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1533 <para>Resets the statistics for each upstream server in an upstream server group.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1534 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1535 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1536 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1537 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1538 <listitem>204 - Success</listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1539 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1540 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1541 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1542 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1543 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1544 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1545 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1546 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1547 <tag-name id="stream_upstreams_stream_upstream_name_servers_" name="/stream/upstreams/{streamUpstreamName}/servers/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1548 <literal>/stream/upstreams/{streamUpstreamName}/servers/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1549 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1550 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1551 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1552 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1553 <tag-name><literal>streamUpstreamName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1554 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1555 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1556 The name of an upstream server group.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1557 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1558 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1559 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1560 <listitem id="getStreamUpstreamServers"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1561 <literal>GET</literal> - Return configuration of all servers in a stream upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1562 <para>Returns configuration of each server in a particular stream upstream server group.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1563 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1564 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1565 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1566 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1567 <listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1568 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1569 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1570 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1571 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1572 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1573 <listitem id="postStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1574 <literal>POST</literal> - Add a server to a stream upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1575 <para>Adds a new server to a stream upstream server group. Server parameters are specified in the JSON format.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1576 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1577 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1578 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1579 <tag-name><literal>postStreamUpstreamServer</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1580 (<link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1581 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1582 Address of a new server and other optional parameters in the JSON format. The “<literal>ID</literal>”, “<literal>backup</literal>”, and “<literal>service</literal>” parameters cannot be changed.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1583 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1584 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1585 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1586 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1587 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1588 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1589 <listitem>201 - Created, returns <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1590 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1591 invalid “<value>parameter</value>” value (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1592 missing “<literal>server</literal>” argument (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1593 unknown parameter “<value>name</value>” (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1594 nested object or list (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1595 “<literal>error</literal>” while parsing (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1596 no port in server “<literal>host</literal>” (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1597 service upstream “<literal>host</literal>” may not have port (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1598 service upstream “<literal>host</literal>” requires domain name (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1599 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1600 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1601 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1602 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1603 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1604 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1605 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1606 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1607 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1608 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1609 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1610 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1611 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2501
2b494b8ff72d
Documented the "Entry exists" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2500
diff
changeset
|
1612 <listitem>409 - Entry exists (<literal>EntryExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1613 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1614 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1615 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1616 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1617 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1618 <tag-name id="stream_upstreams_stream_upstream_name_servers_stream_upstream_server_id" name="/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1619 <literal>/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1620 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1621 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1622 Parameters common for all methods: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1623 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1624 <tag-name><literal>streamUpstreamName</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1625 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1626 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1627 The name of the upstream server group.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1628 <tag-name><literal>streamUpstreamServerId</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1629 (<literal>string</literal>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1630 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1631 The ID of the server.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1632 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1633 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1634 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1635 <listitem id="getStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1636 <literal>GET</literal> - Return configuration of a server in a stream upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1637 <para>Returns configuration of a particular server in the stream upstream server group.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1638 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1639 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1640 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1641 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1642 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1643 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1644 invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1645 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1646 upstream not found (<literal>UpstreamNotFound</literal>), |
2359
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
1647 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1648 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1649 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1650 <listitem id="patchStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1651 <literal>PATCH</literal> - Modify a server in a stream upstream server group |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1652 <para>Modifies settings of a particular server in a stream upstream server group. Server parameters are specified in the JSON format.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1653 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1654 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1655 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1656 <tag-name><literal>patchStreamUpstreamServer</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1657 (<link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link>, required)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1658 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1659 Server parameters, specified in the JSON format. The “<literal>ID</literal>”, “<literal>backup</literal>”, and “<literal>service</literal>” parameters cannot be changed.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1660 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1661 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1662 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1663 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1664 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1665 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1666 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1667 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1668 invalid “<value>parameter</value>” value (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1669 unknown parameter “<value>name</value>” (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1670 nested object or list (<literal>UpstreamConfFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1671 “<literal>error</literal>” while parsing (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1672 invalid “<literal>server</literal>” argument (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1673 no port in server “<literal>host</literal>” (<literal>UpstreamBadAddress</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1674 invalid server ID (<literal>UpstreamBadServerId</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1675 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1676 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1677 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1678 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1679 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1680 reading request body failed <literal>BodyReadError</literal>), |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1681 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1682 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1683 server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1684 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1685 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1686 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1687 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1688 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1689 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1690 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1691 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1692 <listitem id="deleteStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1693 <literal>DELETE</literal> - Remove a server from a stream upstream server group |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1694 <para>Removes a server from a stream server group.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1695 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1696 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1697 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1698 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1699 <listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1700 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1701 invalid server ID (<literal>UpstreamBadServerId</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1702 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1703 <listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1704 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1705 upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
1706 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1707 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1708 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1709 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1710 </tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1711 <tag-name id="stream_keyvals_" name="/stream/keyvals/"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1712 <literal>/stream/keyvals/</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1713 </tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1714 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1715 <para>Supported methods:</para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1716 <list type="bullet" compact="yes"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1717 <listitem id="getStreamKeyvalZones"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1718 <literal>GET</literal> - Return key-value pairs from all stream keyval zones |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1719 <para>Returns key-value pairs for each stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>.</para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1720 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1721 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1722 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1723 <tag-name><literal>fields</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1724 (<literal>string</literal>, optional)</tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1725 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1726 If the “<literal>fields</literal>” value is empty, then only stream keyval zone names will be output.</tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1727 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1728 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1729 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1730 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1731 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1732 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1733 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link>" objects for all stream keyvals</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1734 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1735 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1736 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1737 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1738 </tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1739 <tag-name id="stream_keyvals_stream_keyval_zone_name" name="/stream/keyvals/{streamKeyvalZoneName}"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1740 <literal>/stream/keyvals/{streamKeyvalZoneName}</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1741 </tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1742 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1743 Parameters common for all methods: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1744 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1745 <tag-name><literal>streamKeyvalZoneName</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1746 (<literal>string</literal>, required)</tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1747 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1748 The name of a stream keyval shared memory zone.</tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1749 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1750 <para>Supported methods:</para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1751 <list type="bullet" compact="yes"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1752 <listitem id="getStreamKeyvalZoneKeysValues"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1753 <literal>GET</literal> - Return key-value pairs from a stream keyval zone |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1754 <para>Returns key-value pairs stored in a particular stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>.</para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1755 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1756 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1757 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1758 <tag-name><literal>key</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1759 (<literal>string</literal>, optional)</tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1760 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1761 Get a particular key-value pair from the stream keyval zone.</tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1762 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1763 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1764 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1765 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1766 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1767 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1768 <listitem>200 - Success, returns <link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link></listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1769 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1770 keyval key not found (<literal>KeyvalKeyNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1771 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1772 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1773 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1774 <listitem id="postStreamKeyvalZoneData"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1775 <literal>POST</literal> - Add a key-value pair to the stream keyval zone |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1776 <para>Adds a new key-value pair to the stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the stream keyval shared memory zone is empty.</para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1777 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1778 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1779 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1780 <tag-name><literal>Key-value</literal> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1781 (<link id="def_nginx_stream_keyval_zone_post_patch">Stream Keyval Shared Memory Zone</link>, required)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1782 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1783 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the stream keyval shared memory zone is empty. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</link> directive.</tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1784 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1785 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1786 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1787 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1788 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1789 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1790 <listitem>201 - Created</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1791 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1792 invalid key format (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1793 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1794 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1795 only one key can be added (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1796 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1797 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1798 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1799 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2501
2b494b8ff72d
Documented the "Entry exists" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2500
diff
changeset
|
1800 <listitem>409 - Entry exists (<literal>EntryExists</literal>), |
2b494b8ff72d
Documented the "Entry exists" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2500
diff
changeset
|
1801 key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2493
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
1802 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1803 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1804 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1805 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1806 <listitem id="patchStreamKeyvalZoneKeyValue"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1807 <literal>PATCH</literal> - Modify a key-value or delete a key |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1808 <para>Changes the value of the selected key in the key-value pair, deletes a key by setting the key value to <literal>null</literal>, changes expiration time of a key-value pair. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node. Expiration time is specified in milliseconds with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</link> directive.</para> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1809 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1810 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1811 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1812 <tag-name><literal>streamKeyvalZoneKeyValue</literal> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1813 (<link id="def_nginx_stream_keyval_zone_post_patch">Stream Keyval Shared Memory Zone</link>, required)</tag-name> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1814 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1815 A new value for the key is specified in the JSON format.</tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1816 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1817 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1818 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1819 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1820 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1821 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1822 <listitem>204 - Success</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1823 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1824 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1825 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1826 only one key can be updated (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1827 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1828 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1829 keyval key not found (<literal>KeyvalKeyNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1830 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1831 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2493
407147d8020f
Documented 413 error for PATCH and POST methods in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2469
diff
changeset
|
1832 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1833 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1834 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1835 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1836 <listitem id="deleteStreamKeyvalZoneData"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1837 <literal>DELETE</literal> - Empty the stream keyval zone |
2359
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
1838 <para>Deletes all key-value pairs from the stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, empties the keyval zone only on a target cluster node.</para> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1839 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1840 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1841 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1842 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1843 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1844 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1845 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1846 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1847 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1848 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1849 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1850 </tag-desc> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1851 <tag-name id="stream_zone_sync_" name="/stream/zone_sync/"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1852 <literal>/stream/zone_sync/</literal> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1853 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1854 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1855 <para>Supported methods:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1856 <list type="bullet" compact="yes"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1857 <listitem id="getStreamZoneSync"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1858 <literal>GET</literal> - Return sync status of a node |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1859 <para>Returns synchronization status of a cluster node.</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1860 <para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1861 Possible responses: |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1862 </para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1863 <list type="bullet"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1864 <listitem>200 - Success, returns <link id="def_nginx_stream_zone_sync">Stream Zone Sync Node</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1865 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1866 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1867 </listitem> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1868 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1869 </tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1870 <tag-name id="resolvers_" name="/resolvers/"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1871 <literal>/resolvers/</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1872 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1873 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1874 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1875 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1876 <listitem id="getResolverZones"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1877 <literal>GET</literal> - Return status for all resolver zones |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1878 <para>Returns status information for each <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</link>.</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1879 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1880 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1881 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1882 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1883 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1884 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1885 Limits which fields of resolvers statistics will be output.</tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1886 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1887 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1888 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1889 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1890 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1891 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1892 <listitem>200 - Success, returns a collection of "<link id="def_nginx_resolver_zone">Resolver Zone</link>" objects for all resolvers</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1893 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1894 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1895 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1896 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1897 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1898 <tag-name id="resolvers_resolver_zone_name" name="/resolvers/{resolverZoneName}"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1899 <literal>/resolvers/{resolverZoneName}</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1900 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1901 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1902 Parameters common for all methods: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1903 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1904 <tag-name><literal>resolverZoneName</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1905 (<literal>string</literal>, required)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1906 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1907 The name of a resolver zone.</tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1908 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1909 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1910 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1911 <listitem id="getResolverZone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1912 <literal>GET</literal> - Return statistics of a resolver zone |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1913 <para>Returns statistics stored in a particular resolver <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">zone</link>.</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1914 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1915 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1916 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1917 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1918 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1919 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1920 Limits which fields of the resolver zone will be output (requests, responses, or both).</tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1921 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1922 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1923 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1924 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1925 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1926 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1927 <listitem>200 - Success, returns <link id="def_nginx_resolver_zone">Resolver Zone</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1928 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1929 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1930 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1931 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1932 <listitem id="deleteResolverZoneStat"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1933 <literal>DELETE</literal> - Reset statistics for a resolver zone. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1934 <para>Resets statistics in a particular resolver zone.</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1935 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1936 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1937 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1938 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1939 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1940 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1941 unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1942 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1943 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1944 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1945 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1946 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1947 <tag-name id="ssl" name="/ssl"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1948 <literal>/ssl</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1949 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1950 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1951 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1952 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1953 <listitem id="getSsl"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1954 <literal>GET</literal> - Return SSL statistics |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1955 <para>Returns SSL statistics.</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1956 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1957 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1958 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1959 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1960 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1961 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1962 Limits which fields of SSL statistics will be output.</tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1963 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1964 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1965 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1966 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1967 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1968 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1969 <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1970 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1971 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1972 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1973 <listitem id="deleteSslStat"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1974 <literal>DELETE</literal> - Reset SSL statistics |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1975 <para>Resets counters of SSL handshakes and session reuses.</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1976 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1977 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1978 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1979 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1980 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1981 <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2500
8a9b2efa92aa
Documented the "Method disabled" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2499
diff
changeset
|
1982 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1983 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1984 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1985 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1986 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1987 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1988 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1989 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1990 <section id="definitions" name="Response Objects"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1991 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1992 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1993 <listitem id="def_nginx_object"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1994 <para>nginx:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1995 General information about nginx:<list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1996 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1997 <literal>version</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1998 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1999 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2000 Version of nginx. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2001 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2002 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2003 <literal>build</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2004 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2005 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2006 Name of nginx build. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2007 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2008 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2009 <literal>address</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2010 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2011 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2012 The address of the server that accepted status request. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2013 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2014 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2015 <literal>generation</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2016 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2017 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2018 The total number of configuration <link url="https://nginx.org/en/docs/control.html#reconfiguration">reloads</link>. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2019 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2020 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2021 <literal>load_timestamp</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2022 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2023 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
2024 Time of the last reload of configuration, in the ISO 8601 format with millisecond resolution. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2025 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2026 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2027 <literal>timestamp</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2028 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2029 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
2030 Current time in the ISO 8601 format with millisecond resolution. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2031 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2032 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2033 <literal>pid</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2034 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2035 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2036 The ID of the worker process that handled status request. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2037 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2038 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2039 <literal>ppid</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2040 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2041 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2042 The ID of the master process that started the <link url="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</link>. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2043 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2044 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2045 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2046 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2047 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2048 "nginx" : { |
2439
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
2049 "version" : "1.17.3", |
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
2050 "build" : "nginx-plus-r19", |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2051 "address" : "206.251.255.64", |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
2052 "generation" : 6, |
2439
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
2053 "load_timestamp" : "2019-10-01T11:15:44.467Z", |
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
2054 "timestamp" : "2019-10-01T09:26:07.305Z", |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2055 "pid" : 32212, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2056 "ppid" : 32210 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2057 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2058 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2059 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2060 <listitem id="def_nginx_processes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2061 <para>Processes:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2062 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2063 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2064 <literal>respawned</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2065 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2066 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2067 The total number of abnormally terminated and respawned child processes. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2068 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2069 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2070 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2071 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2072 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2073 "respawned" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2074 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2075 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2076 <listitem id="def_nginx_connections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2077 <para>Connections:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2078 The number of accepted, dropped, active, and idle connections.<list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2079 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2080 <literal>accepted</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2081 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2082 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2083 The total number of accepted client connections. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2084 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2085 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2086 <literal>dropped</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2087 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2088 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2089 The total number of dropped client connections. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2090 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2091 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2092 <literal>active</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2093 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2094 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2095 The current number of active client connections. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2096 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2097 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2098 <literal>idle</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2099 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2100 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2101 The current number of idle client connections. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2102 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2103 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2104 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2105 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2106 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2107 "accepted" : 4968119, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2108 "dropped" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2109 "active" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2110 "idle" : 117 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2111 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2112 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2113 <listitem id="def_nginx_ssl_object"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2114 <para>SSL:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2115 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2116 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2117 <literal>handshakes</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2118 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2119 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2120 The total number of successful SSL handshakes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2121 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2122 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2123 <literal>handshakes_failed</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2124 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2125 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2126 The total number of failed SSL handshakes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2127 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2128 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2129 <literal>session_reuses</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2130 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2131 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2132 The total number of session reuses during SSL handshake. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2133 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2134 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2135 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2136 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2137 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2138 "handshakes" : 79572, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2139 "handshakes_failed" : 21025, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2140 "session_reuses" : 15762 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2141 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2142 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2143 <listitem id="def_nginx_slab_zone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2144 <para>Shared memory zone with slab allocator:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2145 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2146 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2147 <literal>pages</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2148 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2149 The number of free and used memory pages.<list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2150 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2151 <literal>used</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2152 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2153 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2154 The current number of used memory pages. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2155 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2156 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2157 <literal>free</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2158 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2159 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2160 The current number of free memory pages. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2161 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2162 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2163 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2164 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2165 <literal>slots</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2166 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2167 <para>Status data for memory slots (8, 16, 32, 64, 128, etc.)</para><para>A collection of "<link id="def_nginx_slab_zone_slot">Memory Slot</link>" objects</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2168 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2169 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2170 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2171 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2172 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2173 "pages" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2174 "used" : 1143, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2175 "free" : 2928 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2176 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2177 "slots" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2178 "8" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2179 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2180 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2181 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2182 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2183 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2184 "16" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2185 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2186 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2187 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2188 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2189 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2190 "32" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2191 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2192 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2193 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2194 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2195 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2196 "64" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2197 "used" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2198 "free" : 63, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2199 "reqs" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2200 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2201 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2202 "128" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2203 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2204 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2205 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2206 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2207 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2208 "256" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2209 "used" : 18078, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2210 "free" : 178, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2211 "reqs" : 1635736, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2212 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2213 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2214 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2215 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2216 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2217 <listitem id="def_nginx_slab_zone_slot"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2218 <para>Memory Slot:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2219 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2220 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2221 <literal>used</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2222 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2223 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2224 The current number of used memory slots. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2225 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2226 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2227 <literal>free</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2228 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2229 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2230 The current number of free memory slots. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2231 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2232 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2233 <literal>reqs</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2234 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2235 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2236 The total number of attempts to allocate memory of specified size. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2237 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2238 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2239 <literal>fails</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2240 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2241 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2242 The number of unsuccessful attempts to allocate memory of specified size. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2243 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2244 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2245 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2246 <listitem id="def_nginx_http_requests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2247 <para>HTTP Requests:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2248 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2249 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2250 <literal>total</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2251 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2252 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2253 The total number of client requests. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2254 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2255 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2256 <literal>current</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2257 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2258 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2259 The current number of client requests. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2260 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2261 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2262 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2263 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2264 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2265 "total" : 10624511, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2266 "current" : 4 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2267 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2268 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2269 <listitem id="def_nginx_http_server_zone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2270 <para>HTTP Server Zone:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2271 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2272 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2273 <literal>processing</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2274 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2275 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2276 The number of client requests that are currently being processed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2277 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2278 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2279 <literal>requests</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2280 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2281 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2282 The total number of client requests received from clients. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2283 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2284 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2285 <literal>responses</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2286 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2287 The total number of responses sent to clients and the number of responses with status codes “<literal>1xx</literal>”, “<literal>2xx</literal>”, “<literal>3xx</literal>”, “<literal>4xx</literal>”, and “<literal>5xx</literal>”.<list type="tag"> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2288 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2289 <literal>1xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2290 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2291 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2292 The number of responses with “<literal>1xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2293 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2294 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2295 <literal>2xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2296 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2297 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2298 The number of responses with “<literal>2xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2299 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2300 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2301 <literal>3xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2302 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2303 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2304 The number of responses with “<literal>3xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2305 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2306 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2307 <literal>4xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2308 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2309 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2310 The number of responses with “<literal>4xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2311 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2312 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2313 <literal>5xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2314 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2315 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2316 The number of responses with “<literal>5xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2317 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2318 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2319 <literal>total</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2320 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2321 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2322 The total number of responses sent to clients. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2323 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2324 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2325 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2326 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2327 <literal>discarded</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2328 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2329 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2330 The total number of requests completed without sending a response. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2331 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2332 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2333 <literal>received</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2334 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2335 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2336 The total number of bytes received from clients. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2337 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2338 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2339 <literal>sent</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2340 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2341 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2342 The total number of bytes sent to clients. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2343 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2344 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2345 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2346 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2347 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2348 "processing" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2349 "requests" : 706690, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2350 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2351 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2352 "2xx" : 699482, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2353 "3xx" : 4522, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2354 "4xx" : 907, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2355 "5xx" : 266, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2356 "total" : 705177 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2357 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2358 "discarded" : 1513, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2359 "received" : 172711587, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2360 "sent" : 19415530115 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2361 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2362 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2363 <listitem id="def_nginx_http_location_zone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2364 <para>HTTP Location Zone:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2365 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2366 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2367 <literal>requests</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2368 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2369 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2370 The total number of client requests received from clients. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2371 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2372 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2373 <literal>responses</literal></tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2374 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2375 The total number of responses sent to clients and the number of responses with status codes “<literal>1xx</literal>”, “<literal>2xx</literal>”, “<literal>3xx</literal>”, “<literal>4xx</literal>”, and “<literal>5xx</literal>”.<list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2376 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2377 <literal>1xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2378 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2379 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2380 The number of responses with “<literal>1xx</literal>” status codes. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2381 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2382 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2383 <literal>2xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2384 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2385 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2386 The number of responses with “<literal>2xx</literal>” status codes. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2387 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2388 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2389 <literal>3xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2390 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2391 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2392 The number of responses with “<literal>3xx</literal>” status codes. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2393 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2394 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2395 <literal>4xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2396 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2397 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2398 The number of responses with “<literal>4xx</literal>” status codes. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2399 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2400 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2401 <literal>5xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2402 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2403 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2404 The number of responses with “<literal>5xx</literal>” status codes. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2405 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2406 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2407 <literal>total</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2408 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2409 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2410 The total number of responses sent to clients. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2411 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2412 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2413 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2414 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2415 <literal>discarded</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2416 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2417 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2418 The total number of requests completed without sending a response. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2419 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2420 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2421 <literal>received</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2422 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2423 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2424 The total number of bytes received from clients. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2425 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2426 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2427 <literal>sent</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2428 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2429 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2430 The total number of bytes sent to clients. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2431 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2432 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2433 <para>Example:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2434 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2435 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2436 "requests" : 706690, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2437 "responses" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2438 "1xx" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2439 "2xx" : 699482, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2440 "3xx" : 4522, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2441 "4xx" : 907, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2442 "5xx" : 266, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2443 "total" : 705177 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2444 }, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2445 "discarded" : 1513, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2446 "received" : 172711587, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2447 "sent" : 19415530115 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2448 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2449 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2450 <listitem id="def_nginx_http_cache"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2451 <para>HTTP Cache:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2452 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2453 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2454 <literal>size</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2455 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2456 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2457 The current size of the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2458 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2459 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2460 <literal>max_size</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2461 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2462 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2463 The limit on the maximum size of the cache specified in the configuration. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2464 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2465 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2466 <literal>cold</literal> (<literal>boolean</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2467 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2468 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2469 A boolean value indicating whether the “cache loader” process is still loading data from disk into the cache. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2470 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2471 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2472 <literal>hit</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2473 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2474 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2475 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2476 <literal>responses</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2477 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2478 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2479 The total number of <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_valid">valid</link> responses read from the cache. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2480 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2481 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2482 <literal>bytes</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2483 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2484 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2485 The total number of bytes read from the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2486 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2487 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2488 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2489 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2490 <literal>stale</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2491 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2492 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2493 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2494 <literal>responses</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2495 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2496 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2497 The total number of expired responses read from the cache (see <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale">proxy_cache_use_stale</link> and other “<literal>*_cache_use_stale</literal>” directives). |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2498 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2499 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2500 <literal>bytes</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2501 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2502 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2503 The total number of bytes read from the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2504 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2505 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2506 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2507 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2508 <literal>updating</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2509 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2510 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2511 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2512 <literal>responses</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2513 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2514 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2515 The total number of expired responses read from the cache while responses were being updated (see <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale_updating">proxy_cache_use_stale</link> and other “<literal>*_cache_use_stale</literal>” directives). |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2516 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2517 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2518 <literal>bytes</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2519 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2520 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2521 The total number of bytes read from the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2522 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2523 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2524 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2525 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2526 <literal>revalidated</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2527 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2528 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2529 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2530 <literal>responses</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2531 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2532 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2533 The total number of expired and revalidated responses read from the cache (see <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_revalidate">proxy_cache_revalidate</link> and other “<literal>*_cache_revalidate</literal>” directives. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2534 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2535 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2536 <literal>bytes</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2537 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2538 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2539 The total number of bytes read from the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2540 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2541 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2542 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2543 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2544 <literal>miss</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2545 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2546 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2547 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2548 <literal>responses</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2549 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2550 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2551 The total number of responses not found in the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2552 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2553 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2554 <literal>bytes</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2555 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2556 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2557 The total number of bytes read from the proxied server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2558 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2559 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2560 <literal>responses_written</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2561 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2562 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2563 The total number of responses written to the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2564 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2565 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2566 <literal>bytes_written</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2567 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2568 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2569 The total number of bytes written to the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2570 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2571 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2572 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2573 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2574 <literal>expired</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2575 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2576 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2577 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2578 <literal>responses</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2579 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2580 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2581 The total number of expired responses not taken from the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2582 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2583 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2584 <literal>bytes</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2585 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2586 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2587 The total number of bytes read from the proxied server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2588 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2589 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2590 <literal>responses_written</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2591 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2592 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2593 The total number of responses written to the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2594 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2595 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2596 <literal>bytes_written</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2597 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2598 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2599 The total number of bytes written to the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2600 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2601 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2602 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2603 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2604 <literal>bypass</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2605 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2606 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2607 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2608 <literal>responses</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2609 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2610 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2611 The total number of responses not looked up in the cache due to the <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_bypass">proxy_cache_bypass</link> and other “<literal>*_cache_bypass</literal>” directives. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2612 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2613 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2614 <literal>bytes</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2615 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2616 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2617 The total number of bytes read from the proxied server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2618 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2619 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2620 <literal>responses_written</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2621 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2622 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2623 The total number of responses written to the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2624 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2625 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2626 <literal>bytes_written</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2627 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2628 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2629 The total number of bytes written to the cache. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2630 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2631 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2632 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2633 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2634 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2635 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2636 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2637 "size" : 530915328, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2638 "max_size" : 536870912, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2639 "cold" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2640 "hit" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2641 "responses" : 254032, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2642 "bytes" : 6685627875 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2643 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2644 "stale" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2645 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2646 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2647 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2648 "updating" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2649 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2650 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2651 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2652 "revalidated" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2653 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2654 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2655 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2656 "miss" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2657 "responses" : 1619201, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2658 "bytes" : 53841943822 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2659 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2660 "expired" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2661 "responses" : 45859, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2662 "bytes" : 1656847080, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2663 "responses_written" : 44992, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2664 "bytes_written" : 1641825173 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2665 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2666 "bypass" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2667 "responses" : 200187, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2668 "bytes" : 5510647548, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2669 "responses_written" : 200173, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2670 "bytes_written" : 44992 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2671 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2672 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2673 </listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2674 <listitem id="def_nginx_http_limit_conn_zone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2675 <para>HTTP Connections Limiting:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2676 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2677 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2678 <literal>passed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2679 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2680 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2681 The total number of connections that were neither limited nor accounted as limited. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2682 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2683 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2684 <literal>rejected</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2685 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2686 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2687 The total number of connections that were rejected. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2688 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2689 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2690 <literal>rejected_dry_run</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2691 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2692 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2693 The total number of connections accounted as rejected in the <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_dry_run">dry run</link> mode. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2694 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2695 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2696 <para>Example:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2697 <example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2698 { |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2699 "passed" : 15, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2700 "rejected" : 0, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2701 "rejected_dry_run" : 2 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2702 }</example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2703 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2704 <listitem id="def_nginx_http_limit_req_zone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2705 <para>HTTP Requests Rate Limiting:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2706 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2707 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2708 <literal>passed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2709 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2710 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2711 The total number of requests that were neither limited nor accounted as limited. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2712 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2713 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2714 <literal>delayed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2715 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2716 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2717 The total number of requests that were delayed. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2718 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2719 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2720 <literal>rejected</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2721 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2722 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2723 The total number of requests that were rejected. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2724 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2725 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2726 <literal>delayed_dry_run</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2727 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2728 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2729 The total number of requests accounted as delayed in the <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</link> mode. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2730 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2731 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2732 <literal>rejected_dry_run</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2733 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2734 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2735 The total number of requests accounted as rejected in the <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</link> mode. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2736 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2737 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2738 <para>Example:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2739 <example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2740 { |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2741 "passed" : 15, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2742 "delayed" : 4, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2743 "rejected" : 0, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2744 "delayed_dry_run" : 1, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2745 "rejected_dry_run" : 2 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2746 }</example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2747 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2748 <listitem id="def_nginx_http_upstream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2749 <para>HTTP Upstream:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2750 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2751 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2752 <literal>peers</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2753 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2754 An array of:<list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2755 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2756 <literal>id</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2757 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2758 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2759 The ID of the server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2760 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2761 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2762 <literal>server</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2763 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2764 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2765 An <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">address</link> of the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2766 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2767 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2768 <literal>service</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2769 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2770 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2771 The <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</link> parameter value of the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</link> directive. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2772 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2773 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2774 <literal>name</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2775 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2776 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2777 The name of the server specified in the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</link> directive. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2778 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2779 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2780 <literal>backup</literal> (<literal>boolean</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2781 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2782 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2783 A boolean value indicating whether the server is a <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</link> server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2784 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2785 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2786 <literal>weight</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2787 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2788 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2789 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">Weight</link> of the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2790 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2791 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2792 <literal>state</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2793 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2794 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2795 Current state, which may be one of “<literal>up</literal>”, “<literal>draining</literal>”, “<literal>down</literal>”, “<literal>unavail</literal>”, “<literal>checking</literal>”, and “<literal>unhealthy</literal>”. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2796 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2797 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2798 <literal>active</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2799 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2800 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2801 The current number of active connections. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2802 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2803 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2804 <literal>max_conns</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2805 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2806 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2807 The <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</link> limit for the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2808 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2809 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2810 <literal>requests</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2811 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2812 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2813 The total number of client requests forwarded to this server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2814 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2815 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2816 <literal>responses</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2817 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2818 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2819 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2820 <literal>1xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2821 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2822 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2823 The number of responses with “<literal>1xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2824 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2825 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2826 <literal>2xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2827 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2828 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2829 The number of responses with “<literal>2xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2830 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2831 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2832 <literal>3xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2833 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2834 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2835 The number of responses with “<literal>3xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2836 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2837 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2838 <literal>4xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2839 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2840 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2841 The number of responses with “<literal>4xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2842 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2843 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2844 <literal>5xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2845 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2846 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2847 The number of responses with “<literal>5xx</literal>” status codes. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2848 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2849 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2850 <literal>total</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2851 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2852 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2853 The total number of responses obtained from this server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2854 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2855 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2856 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2857 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2858 <literal>sent</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2859 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2860 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2861 The total number of bytes sent to this server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2862 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2863 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2864 <literal>received</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2865 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2866 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2867 The total number of bytes received from this server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2868 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2869 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2870 <literal>fails</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2871 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2872 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2873 The total number of unsuccessful attempts to communicate with the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2874 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2875 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2876 <literal>unavail</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2877 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2878 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2879 How many times the server became unavailable for client requests (state “<literal>unavail</literal>”) due to the number of unsuccessful attempts reaching the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</link> threshold. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2880 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2881 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2882 <literal>health_checks</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2883 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2884 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2885 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2886 <literal>checks</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2887 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2888 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2889 The total number of <link url="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#health_check">health check</link> requests made. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2890 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2891 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2892 <literal>fails</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2893 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2894 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2895 The number of failed health checks. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2896 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2897 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2898 <literal>unhealthy</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2899 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2900 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2901 How many times the server became unhealthy (state “<literal>unhealthy</literal>”). |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2902 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2903 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2904 <literal>last_passed</literal> (<literal>boolean</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2905 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2906 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2907 Boolean indicating if the last health check request was successful and passed <link url="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#match">tests</link>. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2908 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2909 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2910 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2911 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2912 <literal>downtime</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2913 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2914 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2915 Total time the server was in the “<literal>unavail</literal>”, “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2916 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2917 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2918 <literal>downstart</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2919 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2920 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
2921 The time when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”, in the ISO 8601 format with millisecond resolution. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2922 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2923 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2924 <literal>selected</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2925 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2926 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
2927 The time when the server was last selected to process a request, in the ISO 8601 format with millisecond resolution. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2928 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2929 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2930 <literal>header_time</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2931 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2932 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2933 The average time to get the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_header_time">response header</link> from the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2934 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2935 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2936 <literal>response_time</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2937 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2938 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2939 The average time to get the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_response_time">full response</link> from the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2940 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2941 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2942 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2943 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2944 <literal>keepalive</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2945 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2946 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2947 The current number of idle <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive">keepalive</link> connections. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2948 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2949 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2950 <literal>zombies</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2951 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2952 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2953 The current number of servers removed from the group but still processing active client requests. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2954 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2955 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2956 <literal>zone</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2957 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2958 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2959 The name of the shared memory <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">zone</link> that keeps the group’s configuration and run-time state. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2960 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2961 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2962 <literal>queue</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2963 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2964 For the requests <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue">queue</link>, the following data are provided:<list type="tag"> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2965 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2966 <literal>size</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2967 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2968 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2969 The current number of requests in the queue. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2970 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2971 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2972 <literal>max_size</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2973 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2974 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2975 The maximum number of requests that can be in the queue at the same time. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2976 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2977 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2978 <literal>overflows</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2979 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2980 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2981 The total number of requests rejected due to the queue overflow. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2982 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2983 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2984 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2985 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2986 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2987 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2988 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2989 "upstream_backend" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2990 "peers" : [ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2991 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2992 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2993 "server" : "10.0.0.1:8088", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2994 "name" : "10.0.0.1:8088", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2995 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2996 "weight" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2997 "state" : "up", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2998 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2999 "max_conns" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3000 "requests" : 667231, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3001 "header_time" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3002 "response_time" : 36, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3003 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3004 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3005 "2xx" : 666310, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3006 "3xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3007 "4xx" : 915, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3008 "5xx" : 6, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3009 "total" : 667231 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3010 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3011 "sent" : 251946292, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3012 "received" : 19222475454, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3013 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3014 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3015 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3016 "checks" : 26214, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3017 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3018 "unhealthy" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3019 "last_passed" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3020 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3021 "downtime" : 0, |
2439
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
3022 "downstart" : "2019-10-01T11:09:21.602Z", |
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
3023 "selected" : "2019-10-01T15:01:25.000Z" |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3024 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3025 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3026 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3027 "server" : "10.0.0.1:8089", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3028 "name" : "10.0.0.1:8089", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3029 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3030 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3031 "state" : "unhealthy", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3032 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3033 "max_conns" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3034 "requests" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3035 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3036 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3037 "2xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3038 "3xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3039 "4xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3040 "5xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3041 "total" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3042 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3043 "sent" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3044 "received" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3045 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3046 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3047 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3048 "checks" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3049 "fails" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3050 "unhealthy" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3051 "last_passed" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3052 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3053 "downtime" : 262925617, |
2439
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
3054 "downstart" : "2019-10-01T11:09:21.602Z", |
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
3055 "selected" : "2019-10-01T15:01:25.000Z" |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3056 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3057 ], |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3058 "keepalive" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3059 "zombies" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3060 "zone" : "upstream_backend" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3061 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3062 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3063 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3064 <listitem id="def_nginx_http_upstream_conf_server"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3065 <para>HTTP Upstream Server:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3066 Dynamically configurable parameters of an HTTP upstream |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3067 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</link>:<list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3068 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3069 <literal>id</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3070 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3071 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3072 The ID of the HTTP upstream server. The ID is assigned automatically and cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3073 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3074 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3075 <literal>server</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3076 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3077 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3078 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#address">address</link> parameter of the HTTP upstream server. When adding a server, it is possible to specify it as a domain name. In this case, changes of the IP addresses that correspond to a domain name will be monitored and automatically applied to the upstream configuration without the need of restarting nginx. This requires the <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver">resolver</link> directive in the “<literal>http</literal>” block. See also the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#resolve">resolve</link> parameter of the HTTP upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3079 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3080 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3081 <literal>service</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3082 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3083 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3084 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</link> parameter of the HTTP upstream server. This parameter cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3085 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3086 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3087 <literal>weight</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3088 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3089 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3090 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">weight</link> parameter of the HTTP upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3091 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3092 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3093 <literal>max_conns</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3094 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3095 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3096 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</link> parameter of the HTTP upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3097 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3098 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3099 <literal>max_fails</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3100 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3101 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3102 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</link> parameter of the HTTP upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3103 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3104 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
3105 <literal>fail_timeout</literal> (<literal>string</literal>) |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3106 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3107 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3108 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#fail_timeout">fail_timeout</link> parameter of the HTTP upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3109 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3110 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
3111 <literal>slow_start</literal> (<literal>string</literal>) |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3112 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3113 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3114 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#slow_start">slow_start</link> parameter of the HTTP upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3115 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3116 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3117 <literal>route</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3118 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3119 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3120 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#route">route</link> parameter of the HTTP upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3121 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3122 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3123 <literal>backup</literal> (<literal>boolean</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3124 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3125 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3126 When <literal>true</literal>, adds a <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</link> server. This parameter cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3127 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3128 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3129 <literal>down</literal> (<literal>boolean</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3130 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3131 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3132 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#down">down</link> parameter of the HTTP upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3133 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3134 <tag-name> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3135 <literal>drain</literal> (<literal>boolean</literal>) |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3136 </tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3137 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3138 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#drain">drain</link> parameter of the HTTP upstream server. |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3139 </tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3140 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3141 <literal>parent</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3142 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3143 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3144 Parent server ID of the resolved server. The ID is assigned automatically and cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3145 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3146 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3147 <literal>host</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3148 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3149 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3150 Hostname of the resolved server. The hostname is assigned automatically and cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3151 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3152 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3153 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3154 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3155 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3156 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3157 "server" : "10.0.0.1:8089", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3158 "weight" : 4, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3159 "max_conns" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3160 "max_fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3161 "fail_timeout" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3162 "slow_start" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3163 "route" : "", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3164 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3165 "down" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3166 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3167 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3168 <listitem id="def_nginx_http_keyval_zone"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3169 <para>HTTP Keyval Shared Memory Zone:</para> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3170 Contents of an HTTP keyval shared memory zone |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3171 when using the GET method.<para>Example:</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3172 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3173 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3174 "key1" : "value1", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3175 "key2" : "value2", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3176 "key3" : "value3" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3177 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3178 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3179 <listitem id="def_nginx_http_keyval_zone_post_patch"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3180 <para>HTTP Keyval Shared Memory Zone:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3181 Contents of an HTTP keyval shared memory zone |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3182 when using the POST or PATCH methods.<para>Example:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3183 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3184 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3185 "key1" : "value1", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3186 "key2" : "value2", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3187 "key3" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3188 "value" : "value3", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3189 "expire" : 30000 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3190 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3191 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3192 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3193 <listitem id="def_nginx_stream_server_zone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3194 <para>Stream Server Zone:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3195 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3196 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3197 <literal>processing</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3198 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3199 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3200 The number of client connections that are currently being processed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3201 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3202 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3203 <literal>connections</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3204 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3205 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3206 The total number of connections accepted from clients. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3207 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3208 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3209 <literal>sessions</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3210 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3211 The total number of completed sessions, and the number of sessions completed with status codes “<literal>2xx</literal>”, “<literal>4xx</literal>”, or “<literal>5xx</literal>”.<list type="tag"> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3212 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3213 <literal>2xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3214 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3215 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3216 The total number of sessions completed with <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</link> “<literal>2xx</literal>”. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3217 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3218 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3219 <literal>4xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3220 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3221 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3222 The total number of sessions completed with <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</link> “<literal>4xx</literal>”. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3223 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3224 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3225 <literal>5xx</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3226 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3227 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3228 The total number of sessions completed with <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</link> “<literal>5xx</literal>”. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3229 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3230 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3231 <literal>total</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3232 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3233 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3234 The total number of completed client sessions. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3235 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3236 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3237 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3238 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3239 <literal>discarded</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3240 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3241 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3242 The total number of connections completed without creating a session. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3243 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3244 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3245 <literal>received</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3246 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3247 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3248 The total number of bytes received from clients. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3249 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3250 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3251 <literal>sent</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3252 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3253 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3254 The total number of bytes sent to clients. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3255 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3256 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3257 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3258 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3259 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3260 "dns" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3261 "processing" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3262 "connections" : 155569, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3263 "sessions" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3264 "2xx" : 155564, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3265 "4xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3266 "5xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3267 "total" : 155569 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3268 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3269 "discarded" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3270 "received" : 4200363, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3271 "sent" : 20489184 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3272 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3273 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3274 </listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3275 <listitem id="def_nginx_stream_limit_conn_zone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3276 <para>Stream Connections Limiting:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3277 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3278 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3279 <literal>passed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3280 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3281 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3282 The total number of connections that were neither limited nor accounted as limited. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3283 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3284 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3285 <literal>rejected</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3286 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3287 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3288 The total number of connections that were rejected. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3289 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3290 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3291 <literal>rejected_dry_run</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3292 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3293 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3294 The total number of connections accounted as rejected in the <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_dry_run">dry run</link> mode. |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3295 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3296 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3297 <para>Example:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3298 <example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3299 { |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3300 "passed" : 15, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3301 "rejected" : 0, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3302 "rejected_dry_run" : 2 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3303 }</example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3304 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3305 <listitem id="def_nginx_stream_upstream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3306 <para>Stream Upstream:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3307 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3308 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3309 <literal>peers</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3310 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3311 An array of:<list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3312 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3313 <literal>id</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3314 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3315 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3316 The ID of the server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3317 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3318 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3319 <literal>server</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3320 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3321 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3322 An <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</link> of the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3323 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3324 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3325 <literal>service</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3326 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3327 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3328 The <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</link> parameter value of the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</link> directive. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3329 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3330 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3331 <literal>name</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3332 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3333 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3334 The name of the server specified in the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</link> directive. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3335 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3336 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3337 <literal>backup</literal> (<literal>boolean</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3338 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3339 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3340 A boolean value indicating whether the server is a <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</link> server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3341 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3342 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3343 <literal>weight</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3344 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3345 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3346 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">Weight</link> of the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3347 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3348 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3349 <literal>state</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3350 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3351 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3352 Current state, which may be one of “<literal>up</literal>”, “<literal>down</literal>”, “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3353 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3354 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3355 <literal>active</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3356 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3357 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3358 The current number of connections. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3359 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3360 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3361 <literal>max_conns</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3362 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3363 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3364 The <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</link> limit for the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3365 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3366 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3367 <literal>connections</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3368 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3369 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3370 The total number of client connections forwarded to this server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3371 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3372 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3373 <literal>connect_time</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3374 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3375 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3376 The average time to connect to the upstream server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3377 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3378 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3379 <literal>first_byte_time</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3380 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3381 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3382 The average time to receive the first byte of data. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3383 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3384 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3385 <literal>response_time</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3386 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3387 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3388 The average time to receive the last byte of data. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3389 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3390 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3391 <literal>sent</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3392 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3393 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3394 The total number of bytes sent to this server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3395 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3396 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3397 <literal>received</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3398 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3399 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3400 The total number of bytes received from this server. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3401 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3402 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3403 <literal>fails</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3404 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3405 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3406 The total number of unsuccessful attempts to communicate with the server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3407 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3408 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3409 <literal>unavail</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3410 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3411 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3412 How many times the server became unavailable for client connections (state “<literal>unavail</literal>”) due to the number of unsuccessful attempts reaching the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</link> threshold. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3413 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3414 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3415 <literal>health_checks</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3416 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3417 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3418 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3419 <literal>checks</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3420 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3421 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3422 The total number of <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#health_check">health check</link> requests made. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3423 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3424 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3425 <literal>fails</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3426 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3427 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3428 The number of failed health checks. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3429 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3430 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3431 <literal>unhealthy</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3432 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3433 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3434 How many times the server became unhealthy (state “<literal>unhealthy</literal>”). |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3435 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3436 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3437 <literal>last_passed</literal> (<literal>boolean</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3438 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3439 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3440 Boolean indicating whether the last health check request was successful and passed <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#match">tests</link>. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3441 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3442 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3443 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3444 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3445 <literal>downtime</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3446 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3447 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3448 Total time the server was in the “<literal>unavail</literal>”, “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3449 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3450 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3451 <literal>downstart</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3452 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3453 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3454 The time when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”, in the ISO 8601 format with millisecond resolution. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3455 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3456 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3457 <literal>selected</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3458 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3459 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3460 The time when the server was last selected to process a connection, in the ISO 8601 format with millisecond resolution. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3461 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3462 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3463 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3464 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3465 <literal>zombies</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3466 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3467 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3468 The current number of servers removed from the group but still processing active client connections. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3469 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3470 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3471 <literal>zone</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3472 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3473 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3474 The name of the shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#zone">zone</link> that keeps the group’s configuration and run-time state. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3475 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3476 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3477 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3478 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3479 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3480 "dns" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3481 "peers" : [ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3482 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3483 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3484 "server" : "10.0.0.1:12347", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3485 "name" : "10.0.0.1:12347", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3486 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3487 "weight" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3488 "state" : "up", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3489 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3490 "max_conns" : 50, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3491 "connections" : 667231, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3492 "sent" : 251946292, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3493 "received" : 19222475454, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3494 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3495 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3496 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3497 "checks" : 26214, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3498 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3499 "unhealthy" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3500 "last_passed" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3501 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3502 "downtime" : 0, |
2439
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
3503 "downstart" : "2019-10-01T11:09:21.602Z", |
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
3504 "selected" : "2019-10-01T15:01:25.000Z" |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3505 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3506 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3507 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3508 "server" : "10.0.0.1:12348", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3509 "name" : "10.0.0.1:12348", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3510 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3511 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3512 "state" : "unhealthy", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3513 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3514 "max_conns" : 50, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3515 "connections" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3516 "sent" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3517 "received" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3518 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3519 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3520 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3521 "checks" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3522 "fails" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3523 "unhealthy" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3524 "last_passed" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3525 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3526 "downtime" : 262925617, |
2439
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
3527 "downstart" : "2019-10-01T11:09:21.602Z", |
12716b241230
Updated versions and datastamps in the API reference.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2424
diff
changeset
|
3528 "selected" : "2019-10-01T15:01:25.000Z" |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3529 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3530 ], |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3531 "zombies" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3532 "zone" : "dns" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3533 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3534 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3535 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3536 <listitem id="def_nginx_stream_upstream_conf_server"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3537 <para>Stream Upstream Server:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3538 Dynamically configurable parameters of a stream upstream |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3539 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</link>:<list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3540 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3541 <literal>id</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3542 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3543 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3544 The ID of the stream upstream server. The ID is assigned automatically and cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3545 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3546 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3547 <literal>server</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3548 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3549 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3550 Same as the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</link> parameter of the stream upstream server. When adding a server, it is possible to specify it as a domain name. In this case, changes of the IP addresses that correspond to a domain name will be monitored and automatically applied to the upstream configuration without the need of restarting nginx. This requires the <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#resolver">resolver</link> directive in the “<literal>stream</literal>” block. See also the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#resolve">resolve</link> parameter of the stream upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3551 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3552 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3553 <literal>service</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3554 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3555 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3556 Same as the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</link> parameter of the stream upstream server. This parameter cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3557 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3558 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3559 <literal>weight</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3560 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3561 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3562 Same as the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">weight</link> parameter of the stream upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3563 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3564 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3565 <literal>max_conns</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3566 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3567 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3568 Same as the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</link> parameter of the stream upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3569 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3570 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3571 <literal>max_fails</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3572 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3573 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3574 Same as the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</link> parameter of the stream upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3575 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3576 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
3577 <literal>fail_timeout</literal> (<literal>string</literal>) |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3578 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3579 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3580 Same as the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#fail_timeout">fail_timeout</link> parameter of the stream upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3581 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3582 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
3583 <literal>slow_start</literal> (<literal>string</literal>) |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3584 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3585 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3586 Same as the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#slow_start">slow_start</link> parameter of the stream upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3587 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3588 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3589 <literal>backup</literal> (<literal>boolean</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3590 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3591 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3592 When <literal>true</literal>, adds a <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</link> server. This parameter cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3593 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3594 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3595 <literal>down</literal> (<literal>boolean</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3596 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3597 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3598 Same as the <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#down">down</link> parameter of the stream upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3599 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3600 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3601 <literal>parent</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3602 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3603 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3604 Parent server ID of the resolved server. The ID is assigned automatically and cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3605 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3606 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3607 <literal>host</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3608 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3609 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3610 Hostname of the resolved server. The hostname is assigned automatically and cannot be changed. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3611 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3612 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3613 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3614 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3615 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3616 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3617 "server" : "10.0.0.1:12348", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3618 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3619 "max_conns" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3620 "max_fails" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3621 "fail_timeout" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3622 "slow_start" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3623 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3624 "down" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3625 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3626 </listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3627 <listitem id="def_nginx_stream_keyval_zone"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3628 <para>Stream Keyval Shared Memory Zone:</para> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3629 Contents of a stream keyval shared memory zone when using the GET method.<para>Example:</para> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3630 <example> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3631 { |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3632 "key1" : "value1", |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3633 "key2" : "value2", |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3634 "key3" : "value3" |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3635 }</example> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3636 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3637 <listitem id="def_nginx_stream_keyval_zone_post_patch"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3638 <para>Stream Keyval Shared Memory Zone:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3639 Contents of a stream keyval shared memory zone |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3640 when using the POST or PATCH methods.<para>Example:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3641 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3642 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3643 "key1" : "value1", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3644 "key2" : "value2", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3645 "key3" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3646 "value" : "value3", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3647 "expire" : 30000 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3648 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3649 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3650 </listitem> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3651 <listitem id="def_nginx_stream_zone_sync"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3652 <para>Stream Zone Sync Node:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3653 <list type="tag"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3654 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3655 <literal>zones</literal></tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3656 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3657 <para>Synchronization information per each shared memory zone.</para><para>A collection of "<link id="def_nginx_stream_zone_sync_zone">Sync Zone</link>" objects</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3658 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3659 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3660 <literal>status</literal></tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3661 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3662 Synchronization information per node in a cluster.<list type="tag"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3663 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3664 <literal>bytes_in</literal> (<literal>integer</literal>) |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3665 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3666 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3667 The number of bytes received by this node. |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3668 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3669 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3670 <literal>msgs_in</literal> (<literal>integer</literal>) |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3671 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3672 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3673 The number of messages received by this node. |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3674 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3675 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3676 <literal>msgs_out</literal> (<literal>integer</literal>) |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3677 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3678 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3679 The number of messages sent by this node. |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3680 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3681 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3682 <literal>bytes_out</literal> (<literal>integer</literal>) |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3683 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3684 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3685 The number of bytes sent by this node. |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3686 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3687 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3688 <literal>nodes_online</literal> (<literal>integer</literal>) |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3689 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3690 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3691 The number of peers this node is connected to. |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3692 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3693 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3694 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3695 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3696 <para>Example:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3697 <example> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3698 { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3699 "zones" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3700 "zone1" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3701 "records_pending" : 2061, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3702 "records_total" : 260575 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3703 }, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3704 "zone2" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3705 "records_pending" : 0, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3706 "records_total" : 14749 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3707 } |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3708 }, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3709 "status" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3710 "bytes_in" : 1364923761, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3711 "msgs_in" : 337236, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3712 "msgs_out" : 346717, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3713 "bytes_out" : 1402765472, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3714 "nodes_online" : 15 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3715 } |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3716 }</example> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3717 </listitem> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3718 <listitem id="def_nginx_stream_zone_sync_zone"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3719 <para>Sync Zone:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3720 Synchronization status of a shared memory zone.<list type="tag"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3721 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3722 <literal>records_pending</literal> (<literal>integer</literal>) |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3723 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3724 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3725 The number of records that need to be sent to the cluster. |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3726 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3727 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3728 <literal>records_total</literal> (<literal>integer</literal>) |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3729 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3730 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3731 The total number of records stored in the shared memory zone. |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3732 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3733 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
3734 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3735 <listitem id="def_nginx_resolver_zone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3736 <para>Resolver Zone:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3737 Statistics of DNS requests and responses per particular |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3738 <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</link>.<list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3739 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3740 <literal>requests</literal></tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3741 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3742 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3743 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3744 <literal>name</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3745 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3746 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3747 The total number of requests to resolve names to addresses. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3748 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3749 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3750 <literal>srv</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3751 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3752 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3753 The total number of requests to resolve SRV records. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3754 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3755 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3756 <literal>addr</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3757 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3758 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3759 The total number of requests to resolve addresses to names. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3760 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3761 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3762 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3763 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3764 <literal>responses</literal></tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3765 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3766 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3767 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3768 <literal>noerror</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3769 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3770 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3771 The total number of successful responses. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3772 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3773 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3774 <literal>formerr</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3775 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3776 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3777 The total number of FORMERR (<literal>Format error</literal>) responses. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3778 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3779 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3780 <literal>servfail</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3781 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3782 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3783 The total number of SERVFAIL (<literal>Server failure</literal>) responses. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3784 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3785 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3786 <literal>nxdomain</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3787 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3788 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3789 The total number of NXDOMAIN (<literal>Host not found</literal>) responses. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3790 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3791 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3792 <literal>notimp</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3793 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3794 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3795 The total number of NOTIMP (<literal>Unimplemented</literal>) responses. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3796 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3797 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3798 <literal>refused</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3799 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3800 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3801 The total number of REFUSED (<literal>Operation refused</literal>) responses. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3802 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3803 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3804 <literal>timedout</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3805 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3806 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3807 The total number of timed out requests. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3808 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3809 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3810 <literal>unknown</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3811 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3812 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3813 The total number of requests completed with an unknown error. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3814 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3815 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3816 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3817 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3818 <para>Example:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3819 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3820 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3821 "resolver_zone1" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3822 "requests" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3823 "name" : 25460, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3824 "srv" : 130, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3825 "addr" : 2580 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3826 }, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3827 "responses" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3828 "noerror" : 26499, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3829 "formerr" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3830 "servfail" : 3, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3831 "nxdomain" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3832 "notimp" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3833 "refused" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3834 "timedout" : 243, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3835 "unknown" : 478 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3836 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3837 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3838 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3839 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3840 <listitem id="def_nginx_error"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3841 <para>Error:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3842 nginx error object.<list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3843 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3844 <literal>error</literal></tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3845 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3846 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3847 <tag-name> |
2132
a645aa9f2ebf
Changed type of HTTP error code to integer in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2082
diff
changeset
|
3848 <literal>status</literal> (<literal>integer</literal>) |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3849 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3850 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3851 HTTP error code. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3852 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3853 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3854 <literal>text</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3855 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3856 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3857 Error description. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3858 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3859 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3860 <literal>code</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3861 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3862 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3863 Internal nginx error code. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3864 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3865 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3866 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3867 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3868 <literal>request_id</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3869 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3870 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3871 The ID of the request, equals the value of the <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id">$request_id</link> variable. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3872 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3873 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3874 <literal>href</literal> (<literal>string</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3875 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3876 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3877 Link to reference documentation. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3878 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3879 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3880 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3881 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3882 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3883 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3884 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3885 </module> |