Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_api_module.xml @ 2915:923977f02d39
Updated docs for the upcoming NGINX Plus release.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 29 Nov 2022 11:48:55 +0000 |
parents | 3a2d342533fb |
children | a85e4d126bc7 |
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> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
113 http://127.0.0.1/api/8/ |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
114 http://127.0.0.1/api/8/nginx |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
115 http://127.0.0.1/api/8/connections |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
116 http://127.0.0.1/api/8/http/requests |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
117 http://127.0.0.1/api/8/http/server_zones/server_backend |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
118 http://127.0.0.1/api/8/http/caches/cache_backend |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
119 http://127.0.0.1/api/8/http/upstreams/backend |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
120 http://127.0.0.1/api/8/http/upstreams/backend/servers/ |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
121 http://127.0.0.1/api/8/http/upstreams/backend/servers/1 |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
122 http://127.0.0.1/api/8/http/keyvals/one?key=arg1 |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
123 http://127.0.0.1/api/8/stream/ |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
124 http://127.0.0.1/api/8/stream/server_zones/server_backend |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
125 http://127.0.0.1/api/8/stream/upstreams/ |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
126 http://127.0.0.1/api/8/stream/upstreams/backend |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
127 http://127.0.0.1/api/8/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. |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
158 The current API version is “<literal>8</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> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
165 http://127.0.0.1/api/8/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> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
211 The <literal>ssl</literal> data |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
212 for each HTTP |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
213 <link id="def_nginx_http_upstream">upstream</link>, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
214 <link id="def_nginx_http_server_zone">server zone</link>, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
215 and stream |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
216 <link id="def_nginx_stream_upstream">upstream</link>, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
217 <link id="def_nginx_stream_server_zone">server zone</link>, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
218 were added in <link id="api_version">version</link> 8. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
219 </listitem> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
220 |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
221 <listitem> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
222 The <literal>codes</literal> data |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
223 in <literal>responses</literal> for each HTTP |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
224 <link id="def_nginx_http_upstream">upstream</link>, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
225 <link id="def_nginx_http_server_zone">server zone</link>, and |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
226 <link id="def_nginx_http_location_zone">location zone</link> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
227 were added in <link id="api_version">version</link> 7. |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
228 </listitem> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
229 |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
230 <listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
231 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
|
232 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
|
233 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
234 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
235 <listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
236 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
|
237 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
|
238 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
239 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
240 <listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
241 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
|
242 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
|
243 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
244 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
245 <listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
246 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
|
247 <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
|
248 <link id="postHttpKeyvalZoneData">set</link> or |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
249 <link id="patchHttpKeyvalZoneKeyValue">changed</link> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
250 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
|
251 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
252 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
253 <listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
254 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
|
255 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
|
256 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
257 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
258 <listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
259 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
|
260 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
|
261 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
262 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
263 <listitem> |
2359
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
264 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
|
265 <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
|
266 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
|
267 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
|
268 but show an empty value. |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
269 </listitem> |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
270 |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
271 <listitem> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
272 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
|
273 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
|
274 </listitem> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
275 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
276 <listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
277 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
|
278 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
|
279 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
280 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
281 <listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
282 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
|
283 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
|
284 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
285 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
286 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
287 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
288 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
289 </section> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
290 <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
|
291 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
292 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
293 <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
|
294 <literal>/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
295 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
296 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
297 <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
|
298 <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
|
299 <listitem id="getAPIEndpoints"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
300 <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
|
301 <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
|
302 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
303 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
304 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
305 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
306 <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
|
307 <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
|
308 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
309 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
310 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
311 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
312 <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
|
313 <literal>/nginx</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
314 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
315 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
316 <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
|
317 <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
|
318 <listitem id="getNginx"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
319 <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
|
320 <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
|
321 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
322 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
323 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
324 <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
|
325 (<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
|
326 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
327 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
|
328 </list> |
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 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
331 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
332 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
333 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
334 <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
|
335 <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
|
336 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
337 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
338 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
339 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
340 <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
|
341 <literal>/processes</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
342 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
343 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
344 <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
|
345 <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
|
346 <listitem id="getProcesses"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
347 <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
|
348 <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
|
349 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
350 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
351 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
352 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
353 <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
|
354 <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
|
355 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
356 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
357 <listitem id="deleteProcesses"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
358 <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
|
359 <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
|
360 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
361 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
362 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
363 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
364 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
365 <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
|
366 <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
|
367 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
368 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
369 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
370 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
371 <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
|
372 <literal>/connections</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
373 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
374 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
375 <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
|
376 <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
|
377 <listitem id="getConnections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
378 <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
|
379 <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
|
380 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
381 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
382 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
383 <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
|
384 (<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
|
385 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
386 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
|
387 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
388 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
389 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
390 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
391 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
392 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
393 <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
|
394 <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
|
395 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
396 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
397 <listitem id="deleteConnections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
398 <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
|
399 <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
|
400 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
401 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
402 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
403 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
404 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
405 <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
|
406 <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
|
407 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
408 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
409 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
410 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
411 <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
|
412 <literal>/slabs/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
413 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
414 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
415 <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
|
416 <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
|
417 <listitem id="getSlabs"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
418 <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
|
419 <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
|
420 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
421 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
422 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
423 <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
|
424 (<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
|
425 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
426 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
|
427 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
428 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
429 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
430 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
431 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
432 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
433 <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
|
434 <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
|
435 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
436 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
437 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
438 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
439 <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
|
440 <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
|
441 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
442 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
443 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
|
444 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
445 <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
|
446 (<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
|
447 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
448 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
|
449 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
450 <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
|
451 <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
|
452 <listitem id="getSlabZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
453 <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
|
454 <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
|
455 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
456 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
457 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
458 <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
|
459 (<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
|
460 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
461 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
|
462 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
463 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
464 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
465 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
466 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
467 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
468 <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
|
469 <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
|
470 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
|
471 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
472 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
473 <listitem id="deleteSlabZoneStats"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
474 <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
|
475 <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
|
476 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
477 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
478 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
479 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
480 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
481 <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
|
482 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
|
483 <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
|
484 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
485 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
486 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
487 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
488 <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
|
489 <literal>/http/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
490 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
491 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
492 <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
|
493 <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
|
494 <listitem id="getHttp"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
495 <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
|
496 <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
|
497 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
498 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
499 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
500 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
501 <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
|
502 <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
|
503 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
504 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
505 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
506 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
507 <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
|
508 <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
|
509 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
510 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
511 <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
|
512 <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
|
513 <listitem id="getHttpRequests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
514 <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
|
515 <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
|
516 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
517 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
518 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
519 <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
|
520 (<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
|
521 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
522 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
|
523 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
524 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
525 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
526 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
527 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
528 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
529 <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
|
530 <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
|
531 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
532 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
533 <listitem id="deleteHttpRequests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
534 <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
|
535 <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
|
536 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
537 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
538 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
539 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
540 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
541 <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
|
542 <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
|
543 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
544 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
545 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
546 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
547 <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
|
548 <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
|
549 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
550 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
551 <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
|
552 <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
|
553 <listitem id="getHttpServerZones"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
554 <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
|
555 <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
|
556 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
557 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
558 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
559 <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
|
560 (<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
|
561 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
562 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
|
563 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
564 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
565 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
566 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
567 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
568 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
569 <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
|
570 <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
|
571 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
572 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
573 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
574 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
575 <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
|
576 <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
|
577 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
578 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
579 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
|
580 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
581 <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
|
582 (<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
|
583 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
584 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
|
585 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
586 <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
|
587 <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
|
588 <listitem id="getHttpServerZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
589 <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
|
590 <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
|
591 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
592 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
593 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
594 <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
|
595 (<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
|
596 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
597 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
|
598 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
599 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
600 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
601 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
602 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
603 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
604 <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
|
605 <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
|
606 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
|
607 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
608 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
609 <listitem id="deleteHttpServerZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
610 <literal>DELETE</literal> - Reset statistics for an HTTP server zone |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
611 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes, counters of SSL handshakes and session reuses 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
|
612 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
613 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
614 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
615 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
616 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
617 <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
|
618 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
|
619 <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
|
620 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
621 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
622 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
623 </tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
624 <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
|
625 <literal>/http/location_zones/</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
626 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
627 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
628 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
629 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
630 <listitem id="getHttpLocationZones"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
631 <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
|
632 <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
|
633 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
634 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
635 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
636 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
637 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
638 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
639 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
|
640 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
641 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
642 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
643 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
644 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
645 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
646 <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
|
647 <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
|
648 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
649 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
650 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
651 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
652 <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
|
653 <literal>/http/location_zones/{httpLocationZoneName}</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
654 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
655 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
656 Parameters common for all methods: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
657 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
658 <tag-name><literal>httpLocationZoneName</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
659 (<literal>string</literal>, required)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
660 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
661 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
|
662 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
663 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
664 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
665 <listitem id="getHttpLocationZone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
666 <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
|
667 <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
|
668 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
669 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
670 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
671 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
672 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
673 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
674 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
|
675 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
676 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
677 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
678 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
679 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
680 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
681 <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
|
682 <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
|
683 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
|
684 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
685 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
686 <listitem id="deleteHttpLocationZoneStat"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
687 <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
|
688 <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
|
689 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
690 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
691 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
692 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
693 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
694 <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
|
695 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
|
696 <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
|
697 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
698 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
699 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
700 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
701 <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
|
702 <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
|
703 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
704 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
705 <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
|
706 <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
|
707 <listitem id="getHttpCaches"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
708 <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
|
709 <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
|
710 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
711 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
712 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
713 <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
|
714 (<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
|
715 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
716 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
|
717 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
718 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
719 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
720 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
721 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
722 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
723 <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
|
724 <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
|
725 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
726 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
727 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
728 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
729 <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
|
730 <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
|
731 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
732 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
733 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
|
734 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
735 <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
|
736 (<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
|
737 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
738 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
|
739 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
740 <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
|
741 <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
|
742 <listitem id="getHttpCacheZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
743 <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
|
744 <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
|
745 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
746 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
747 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
748 <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
|
749 (<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
|
750 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
751 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
|
752 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
753 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
754 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
755 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
756 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
757 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
758 <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
|
759 <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
|
760 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
|
761 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
762 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
763 <listitem id="deleteHttpCacheZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
764 <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
|
765 <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
|
766 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
767 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
768 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
769 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
770 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
771 <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
|
772 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
|
773 <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
|
774 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
775 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
776 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
777 </tag-desc> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
778 <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
|
779 <literal>/http/limit_conns/</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
780 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
781 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
782 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
783 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
784 <listitem id="getHttpLimitConnZones"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
785 <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
|
786 <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
|
787 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
788 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
789 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
790 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
791 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
792 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
793 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
|
794 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
795 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
796 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
797 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
798 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
799 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
800 <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
|
801 <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
|
802 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
803 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
804 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
805 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
806 <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
|
807 <literal>/http/limit_conns/{httpLimitConnZoneName}</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
808 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
809 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
810 Parameters common for all methods: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
811 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
812 <tag-name><literal>httpLimitConnZoneName</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
813 (<literal>string</literal>, required)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
814 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
815 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
|
816 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
817 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
818 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
819 <listitem id="getHttpLimitConnZone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
820 <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
|
821 <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
|
822 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
823 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
824 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
825 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
826 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
827 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
828 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
|
829 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
830 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
831 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
832 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
833 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
834 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
835 <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
|
836 <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
|
837 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
|
838 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
839 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
840 <listitem id="deleteHttpLimitConnZoneStat"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
841 <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
|
842 <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
|
843 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
844 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
845 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
846 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
847 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
848 <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
|
849 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
|
850 <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
|
851 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
852 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
853 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
854 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
855 <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
|
856 <literal>/http/limit_reqs/</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
857 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
858 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
859 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
860 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
861 <listitem id="getHttpLimitReqZones"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
862 <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
|
863 <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
|
864 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
865 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
866 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
867 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
868 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
869 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
870 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
|
871 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
872 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
873 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
874 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
875 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
876 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
877 <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
|
878 <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
|
879 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
880 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
881 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
882 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
883 <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
|
884 <literal>/http/limit_reqs/{httpLimitReqZoneName}</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
885 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
886 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
887 Parameters common for all methods: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
888 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
889 <tag-name><literal>httpLimitReqZoneName</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
890 (<literal>string</literal>, required)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
891 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
892 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
|
893 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
894 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
895 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
896 <listitem id="getHttpLimitReqZone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
897 <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
|
898 <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
|
899 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
900 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
901 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
902 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
903 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
904 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
905 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
|
906 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
907 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
908 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
909 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
910 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
911 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
912 <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
|
913 <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
|
914 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
|
915 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
916 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
917 <listitem id="deleteHttpLimitReqZoneStat"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
918 <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
|
919 <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
|
920 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
921 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
922 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
923 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
924 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
925 <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
|
926 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
|
927 <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
|
928 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
929 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
930 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
931 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
932 <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
|
933 <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
|
934 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
935 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
936 <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
|
937 <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
|
938 <listitem id="getHttpUpstreams"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
939 <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
|
940 <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
|
941 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
942 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
943 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
944 <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
|
945 (<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
|
946 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
947 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
|
948 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
949 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
950 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
951 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
952 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
953 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
954 <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
|
955 <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
|
956 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
957 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
958 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
959 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
960 <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
|
961 <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
|
962 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
963 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
964 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
|
965 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
966 <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
|
967 (<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
|
968 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
969 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
|
970 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
971 <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
|
972 <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
|
973 <listitem id="getHttpUpstreamName"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
974 <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
|
975 <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
|
976 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
977 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
978 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
979 <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
|
980 (<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
|
981 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
982 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
|
983 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
984 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
985 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
986 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
987 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
988 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
989 <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
|
990 <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
|
991 <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
|
992 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
|
993 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
994 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
995 <listitem id="deleteHttpUpstreamStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
996 <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
|
997 <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
|
998 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
999 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1000 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1001 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1002 <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
|
1003 <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
|
1004 <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
|
1005 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
|
1006 <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
|
1007 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1008 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1009 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1010 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1011 <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
|
1012 <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
|
1013 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1014 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1015 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
|
1016 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1017 <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
|
1018 (<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
|
1019 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1020 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
|
1021 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1022 <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
|
1023 <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
|
1024 <listitem id="getHttpUpstreamServers"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1025 <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
|
1026 <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
|
1027 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1028 Possible responses: |
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 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1031 <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
|
1032 <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
|
1033 <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
|
1034 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
|
1035 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1036 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1037 <listitem id="postHttpUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1038 <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
|
1039 <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
|
1040 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1041 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1042 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1043 <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
|
1044 (<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
|
1045 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1046 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
|
1047 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1048 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1049 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1050 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1051 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1052 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1053 <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
|
1054 <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
|
1055 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
|
1056 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
|
1057 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
|
1058 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
|
1059 “<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
|
1060 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
|
1061 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
|
1062 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
|
1063 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
|
1064 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
|
1065 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
|
1066 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1067 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
|
1068 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
|
1069 “<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
|
1070 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
|
1071 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
|
1072 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
|
1073 <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
|
1074 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
|
1075 <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
|
1076 <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
|
1077 <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
|
1078 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1079 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1080 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1081 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1082 <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
|
1083 <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
|
1084 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1085 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1086 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
|
1087 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1088 <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
|
1089 (<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
|
1090 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1091 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
|
1092 <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
|
1093 (<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
|
1094 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1095 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
|
1096 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1097 <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
|
1098 <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
|
1099 <listitem id="getHttpUpstreamPeer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1100 <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
|
1101 <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
|
1102 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1103 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1104 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1105 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1106 <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
|
1107 <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
|
1108 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
|
1109 <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
|
1110 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1111 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
|
1112 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1113 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1114 <listitem id="patchHttpUpstreamPeer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1115 <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
|
1116 <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
|
1117 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1118 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1119 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1120 <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
|
1121 (<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
|
1122 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1123 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
|
1124 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1125 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1126 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1127 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1128 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1129 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1130 <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
|
1131 <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
|
1132 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
|
1133 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
|
1134 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
|
1135 “<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
|
1136 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
|
1137 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
|
1138 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
|
1139 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
|
1140 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
|
1141 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
|
1142 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1143 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
|
1144 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
|
1145 “<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
|
1146 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
|
1147 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
|
1148 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
|
1149 <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
|
1150 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1151 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
|
1152 <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
|
1153 <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
|
1154 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1155 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1156 <listitem id="deleteHttpUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1157 <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
|
1158 <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
|
1159 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1160 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1161 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1162 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1163 <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
|
1164 <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
|
1165 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
|
1166 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
|
1167 <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
|
1168 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1169 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
|
1170 <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
|
1171 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1172 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1173 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1174 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1175 <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
|
1176 <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
|
1177 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1178 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1179 <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
|
1180 <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
|
1181 <listitem id="getHttpKeyvalZones"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1182 <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
|
1183 <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
|
1184 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1185 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1186 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1187 <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
|
1188 (<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
|
1189 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1190 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
|
1191 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1192 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1193 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1194 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1195 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1196 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1197 <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
|
1198 <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
|
1199 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1200 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1201 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1202 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1203 <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
|
1204 <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
|
1205 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1206 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1207 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
|
1208 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1209 <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
|
1210 (<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
|
1211 <tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1212 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
|
1213 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1214 <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
|
1215 <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
|
1216 <listitem id="getHttpKeyvalZoneKeysValues"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1217 <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
|
1218 <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
|
1219 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1220 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1221 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1222 <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
|
1223 (<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
|
1224 <tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1225 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
|
1226 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1227 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1228 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1229 Possible responses: |
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 <list type="bullet"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1232 <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
|
1233 <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
|
1234 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
|
1235 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
|
1236 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1237 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1238 <listitem id="postHttpKeyvalZoneData"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1239 <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
|
1240 <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
|
1241 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1242 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1243 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1244 <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
|
1245 (<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
|
1246 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1247 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
|
1248 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1249 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1250 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1251 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1252 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1253 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1254 <listitem>201 - Created</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1255 <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
|
1256 invalid key format (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1257 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1258 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1259 only one key can be added (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1260 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
|
1261 <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
|
1262 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
|
1263 <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
|
1264 <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
|
1265 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
|
1266 <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
|
1267 <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
|
1268 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1269 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1270 <listitem id="patchHttpKeyvalZoneKeyValue"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1271 <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
|
1272 <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
|
1273 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1274 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1275 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1276 <tag-name><literal>httpKeyvalZoneKeyValue</literal> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1277 (<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
|
1278 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1279 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
|
1280 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1281 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1282 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1283 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1284 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1285 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1286 <listitem>204 - Success</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1287 <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
|
1288 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1289 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1290 only one key can be updated (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1291 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
|
1292 <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
|
1293 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
|
1294 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
|
1295 <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
|
1296 <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
|
1297 <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
|
1298 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1299 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1300 <listitem id="deleteHttpKeyvalZoneData"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1301 <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
|
1302 <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
|
1303 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1304 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1305 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1306 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1307 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1308 <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
|
1309 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
|
1310 <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
|
1311 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1312 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1313 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1314 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1315 <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
|
1316 <literal>/stream/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1317 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1318 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1319 <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
|
1320 <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
|
1321 <listitem id="getStream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1322 <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
|
1323 <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
|
1324 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1325 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1326 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1327 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1328 <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
|
1329 <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
|
1330 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1331 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1332 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1333 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1334 <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
|
1335 <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
|
1336 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1337 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1338 <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
|
1339 <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
|
1340 <listitem id="getStreamServerZones"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1341 <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
|
1342 <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
|
1343 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1344 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1345 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1346 <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
|
1347 (<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
|
1348 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1349 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
|
1350 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1351 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1352 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1353 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1354 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1355 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1356 <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
|
1357 <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
|
1358 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1359 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1360 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1361 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1362 <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
|
1363 <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
|
1364 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1365 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1366 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
|
1367 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1368 <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
|
1369 (<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
|
1370 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1371 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
|
1372 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1373 <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
|
1374 <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
|
1375 <listitem id="getStreamServerZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1376 <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
|
1377 <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
|
1378 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1379 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1380 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1381 <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
|
1382 (<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
|
1383 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1384 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
|
1385 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1386 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1387 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1388 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1389 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1390 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1391 <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
|
1392 <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
|
1393 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
|
1394 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1395 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1396 <listitem id="deleteStreamServerZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1397 <literal>DELETE</literal> - Reset statistics for a stream server zone |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
1398 <para>Resets statistics of accepted and discarded connections, sessions, received and sent bytes, counters of SSL handshakes and session reuses 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
|
1399 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1400 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1401 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1402 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1403 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1404 <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
|
1405 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
|
1406 <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
|
1407 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1408 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1409 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1410 </tag-desc> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1411 <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
|
1412 <literal>/stream/limit_conns/</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1413 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1414 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1415 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1416 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1417 <listitem id="getStreamLimitConnZones"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1418 <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
|
1419 <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
|
1420 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1421 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1422 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1423 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1424 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1425 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1426 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
|
1427 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1428 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1429 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1430 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1431 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1432 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1433 <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
|
1434 <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
|
1435 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1436 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1437 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1438 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1439 <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
|
1440 <literal>/stream/limit_conns/{streamLimitConnZoneName}</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1441 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1442 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1443 Parameters common for all methods: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1444 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1445 <tag-name><literal>streamLimitConnZoneName</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1446 (<literal>string</literal>, required)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1447 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1448 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
|
1449 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1450 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1451 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1452 <listitem id="getStreamLimitConnZone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1453 <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
|
1454 <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
|
1455 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1456 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1457 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1458 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1459 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1460 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1461 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
|
1462 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1463 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1464 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1465 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1466 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1467 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1468 <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
|
1469 <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
|
1470 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
|
1471 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1472 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1473 <listitem id="deleteStreamLimitConnZoneStat"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1474 <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
|
1475 <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
|
1476 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1477 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1478 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1479 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1480 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1481 <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
|
1482 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
|
1483 <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
|
1484 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1485 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1486 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1487 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1488 <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
|
1489 <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
|
1490 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1491 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1492 <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
|
1493 <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
|
1494 <listitem id="getStreamUpstreams"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1495 <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
|
1496 <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
|
1497 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1498 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1499 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1500 <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
|
1501 (<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
|
1502 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1503 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
|
1504 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1505 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1506 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1507 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1508 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1509 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1510 <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
|
1511 <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
|
1512 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1513 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1514 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1515 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1516 <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
|
1517 <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
|
1518 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1519 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1520 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
|
1521 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1522 <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
|
1523 (<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
|
1524 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1525 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
|
1526 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1527 <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
|
1528 <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
|
1529 <listitem id="getStreamUpstream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1530 <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
|
1531 <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
|
1532 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1533 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1534 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1535 <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
|
1536 (<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
|
1537 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1538 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
|
1539 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1540 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1541 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1542 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1543 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1544 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1545 <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
|
1546 <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
|
1547 <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
|
1548 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
|
1549 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1550 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1551 <listitem id="deleteStreamUpstreamStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1552 <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
|
1553 <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
|
1554 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1555 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1556 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1557 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1558 <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
|
1559 <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
|
1560 <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
|
1561 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
|
1562 <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
|
1563 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1564 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1565 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1566 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1567 <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
|
1568 <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
|
1569 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1570 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1571 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
|
1572 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1573 <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
|
1574 (<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
|
1575 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1576 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
|
1577 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1578 <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
|
1579 <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
|
1580 <listitem id="getStreamUpstreamServers"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1581 <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
|
1582 <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
|
1583 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1584 Possible responses: |
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 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1587 <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
|
1588 <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
|
1589 <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
|
1590 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
|
1591 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1592 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1593 <listitem id="postStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1594 <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
|
1595 <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
|
1596 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1597 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1598 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1599 <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
|
1600 (<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
|
1601 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1602 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
|
1603 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1604 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1605 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1606 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1607 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1608 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1609 <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
|
1610 <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
|
1611 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
|
1612 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
|
1613 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
|
1614 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
|
1615 “<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
|
1616 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
|
1617 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
|
1618 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
|
1619 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
|
1620 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
|
1621 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
|
1622 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
|
1623 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
|
1624 “<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
|
1625 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
|
1626 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
|
1627 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1628 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
|
1629 <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
|
1630 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
|
1631 <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
|
1632 <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
|
1633 <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
|
1634 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1635 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1636 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1637 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1638 <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
|
1639 <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
|
1640 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1641 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1642 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
|
1643 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1644 <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
|
1645 (<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
|
1646 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1647 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
|
1648 <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
|
1649 (<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
|
1650 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1651 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
|
1652 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1653 <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
|
1654 <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
|
1655 <listitem id="getStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1656 <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
|
1657 <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
|
1658 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1659 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1660 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1661 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1662 <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
|
1663 <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
|
1664 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
|
1665 <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
|
1666 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
|
1667 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
|
1668 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1669 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1670 <listitem id="patchStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1671 <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
|
1672 <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
|
1673 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1674 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1675 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1676 <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
|
1677 (<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
|
1678 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1679 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
|
1680 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1681 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1682 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1683 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1684 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1685 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1686 <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
|
1687 <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
|
1688 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
|
1689 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
|
1690 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
|
1691 “<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
|
1692 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
|
1693 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
|
1694 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
|
1695 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
|
1696 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
|
1697 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
|
1698 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
|
1699 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1700 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
|
1701 “<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
|
1702 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
|
1703 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
|
1704 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
|
1705 <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
|
1706 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1707 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
|
1708 <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
|
1709 <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
|
1710 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1711 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1712 <listitem id="deleteStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1713 <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
|
1714 <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
|
1715 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1716 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1717 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1718 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1719 <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
|
1720 <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
|
1721 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
|
1722 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
|
1723 <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
|
1724 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1725 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
|
1726 <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
|
1727 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1728 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1729 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1730 </tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1731 <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
|
1732 <literal>/stream/keyvals/</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1733 </tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1734 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1735 <para>Supported methods:</para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1736 <list type="bullet" compact="yes"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1737 <listitem id="getStreamKeyvalZones"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1738 <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
|
1739 <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
|
1740 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1741 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1742 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1743 <tag-name><literal>fields</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1744 (<literal>string</literal>, optional)</tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1745 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1746 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
|
1747 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1748 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1749 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1750 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1751 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1752 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1753 <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
|
1754 <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
|
1755 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1756 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1757 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1758 </tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1759 <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
|
1760 <literal>/stream/keyvals/{streamKeyvalZoneName}</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1761 </tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1762 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1763 Parameters common for all methods: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1764 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1765 <tag-name><literal>streamKeyvalZoneName</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1766 (<literal>string</literal>, required)</tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1767 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1768 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
|
1769 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1770 <para>Supported methods:</para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1771 <list type="bullet" compact="yes"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1772 <listitem id="getStreamKeyvalZoneKeysValues"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1773 <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
|
1774 <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
|
1775 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1776 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1777 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1778 <tag-name><literal>key</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1779 (<literal>string</literal>, optional)</tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1780 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1781 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
|
1782 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1783 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1784 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1785 Possible responses: |
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 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1788 <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
|
1789 <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
|
1790 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
|
1791 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
|
1792 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1793 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1794 <listitem id="postStreamKeyvalZoneData"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1795 <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
|
1796 <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
|
1797 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1798 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1799 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1800 <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
|
1801 (<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
|
1802 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1803 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
|
1804 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1805 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1806 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1807 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1808 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1809 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1810 <listitem>201 - Created</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1811 <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
|
1812 invalid key format (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1813 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1814 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1815 only one key can be added (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1816 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
|
1817 <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
|
1818 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
|
1819 <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
|
1820 <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
|
1821 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
|
1822 <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
|
1823 <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
|
1824 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1825 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1826 <listitem id="patchStreamKeyvalZoneKeyValue"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1827 <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
|
1828 <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
|
1829 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1830 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1831 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1832 <tag-name><literal>streamKeyvalZoneKeyValue</literal> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1833 (<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
|
1834 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1835 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
|
1836 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1837 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1838 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1839 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1840 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1841 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1842 <listitem>204 - Success</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1843 <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
|
1844 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1845 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1846 only one key can be updated (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1847 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
|
1848 <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
|
1849 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
|
1850 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
|
1851 <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
|
1852 <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
|
1853 <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
|
1854 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1855 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1856 <listitem id="deleteStreamKeyvalZoneData"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1857 <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
|
1858 <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
|
1859 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1860 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1861 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1862 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1863 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1864 <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
|
1865 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
|
1866 <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
|
1867 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1868 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1869 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1870 </tag-desc> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1871 <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
|
1872 <literal>/stream/zone_sync/</literal> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1873 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1874 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1875 <para>Supported methods:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1876 <list type="bullet" compact="yes"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1877 <listitem id="getStreamZoneSync"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1878 <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
|
1879 <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
|
1880 <para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1881 Possible responses: |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1882 </para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1883 <list type="bullet"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1884 <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
|
1885 <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
|
1886 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1887 </listitem> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1888 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1889 </tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1890 <tag-name id="resolvers_" name="/resolvers/"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1891 <literal>/resolvers/</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1892 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1893 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1894 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1895 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1896 <listitem id="getResolverZones"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1897 <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
|
1898 <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
|
1899 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1900 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1901 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1902 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1903 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1904 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1905 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
|
1906 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1907 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1908 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1909 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1910 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1911 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1912 <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
|
1913 <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
|
1914 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1915 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1916 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1917 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1918 <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
|
1919 <literal>/resolvers/{resolverZoneName}</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1920 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1921 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1922 Parameters common for all methods: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1923 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1924 <tag-name><literal>resolverZoneName</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1925 (<literal>string</literal>, required)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1926 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1927 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
|
1928 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1929 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1930 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1931 <listitem id="getResolverZone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1932 <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
|
1933 <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
|
1934 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1935 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1936 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1937 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1938 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1939 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1940 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
|
1941 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1942 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1943 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1944 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1945 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1946 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1947 <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
|
1948 <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
|
1949 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
|
1950 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1951 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1952 <listitem id="deleteResolverZoneStat"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1953 <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
|
1954 <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
|
1955 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1956 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1957 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1958 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1959 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1960 <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
|
1961 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
|
1962 <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
|
1963 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1964 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1965 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1966 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1967 <tag-name id="ssl" name="/ssl"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1968 <literal>/ssl</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1969 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1970 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1971 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1972 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1973 <listitem id="getSsl"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1974 <literal>GET</literal> - Return SSL statistics |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1975 <para>Returns SSL statistics.</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 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1978 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1979 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1980 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1981 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1982 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
|
1983 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1984 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1985 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1986 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1987 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1988 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1989 <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
|
1990 <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
|
1991 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1992 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1993 <listitem id="deleteSslStat"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1994 <literal>DELETE</literal> - Reset SSL statistics |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1995 <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
|
1996 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1997 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1998 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1999 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2000 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
2001 <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
|
2002 <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
|
2003 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2004 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2005 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2006 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2007 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2008 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2009 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2010 <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
|
2011 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2012 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2013 <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
|
2014 <para>nginx:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2015 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
|
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 <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
|
2018 </tag-name> |
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 Version of nginx. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2021 </tag-desc> |
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 <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
|
2024 </tag-name> |
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 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
|
2027 </tag-desc> |
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 <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
|
2030 </tag-name> |
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 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
|
2033 </tag-desc> |
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 <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
|
2036 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2037 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2038 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
|
2039 </tag-desc> |
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 <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
|
2042 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2043 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
2044 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
|
2045 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2046 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2047 <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
|
2048 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2049 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
2050 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
|
2051 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2052 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2053 <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
|
2054 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2055 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2056 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
|
2057 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2058 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2059 <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
|
2060 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2061 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2062 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
|
2063 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2064 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2065 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2066 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2067 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2068 "nginx" : { |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2069 "version" : "1.21.6", |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2070 "build" : "nginx-plus-r27", |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2071 "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
|
2072 "generation" : 6, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2073 "load_timestamp" : "2022-06-28T11:15:44.467Z", |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2074 "timestamp" : "2022-06-28T09: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
|
2075 "pid" : 32212, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2076 "ppid" : 32210 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2077 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2078 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2079 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2080 <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
|
2081 <para>Processes:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2082 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2083 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2084 <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
|
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 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2087 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
|
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 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2090 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2091 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2092 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2093 "respawned" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2094 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2095 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2096 <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
|
2097 <para>Connections:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2098 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
|
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 <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
|
2101 </tag-name> |
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 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
|
2104 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2105 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2106 <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
|
2107 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2108 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2109 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
|
2110 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2111 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2112 <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
|
2113 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2114 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2115 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
|
2116 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2117 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2118 <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
|
2119 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2120 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2121 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
|
2122 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2123 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2124 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2125 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2126 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2127 "accepted" : 4968119, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2128 "dropped" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2129 "active" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2130 "idle" : 117 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2131 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2132 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2133 <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
|
2134 <para>SSL:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2135 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2136 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2137 <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
|
2138 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2139 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2140 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
|
2141 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2142 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2143 <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
|
2144 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2145 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2146 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
|
2147 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2148 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2149 <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
|
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 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2152 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
|
2153 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2154 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2155 <literal>no_common_protocol</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2156 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2157 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2158 The number of SSL handshakes failed because of no common protocol. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2159 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2160 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2161 <literal>no_common_cipher</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2162 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2163 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2164 The number of SSL handshakes failed because of no shared cipher. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2165 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2166 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2167 <literal>handshake_timeout</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2168 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2169 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2170 The number of SSL handshakes failed because of a timeout. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2171 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2172 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2173 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2174 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2175 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2176 The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2177 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2178 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2179 <literal>verify_failures</literal></tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2180 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2181 SSL certificate verification errors<list type="tag"> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2182 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2183 <literal>no_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2184 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2185 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2186 A client did not provide the required certificate. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2187 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2188 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2189 <literal>expired_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2190 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2191 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2192 An expired or not yet valid certificate was presented by a client. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2193 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2194 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2195 <literal>revoked_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2196 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2197 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2198 A revoked certificate was presented by a client. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2199 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2200 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2201 <literal>hostname_mismatch</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2202 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2203 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2204 Server's certificate doesn't match the hostname. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2205 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2206 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2207 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2208 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2209 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2210 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2211 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2212 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2213 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2214 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2215 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2216 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2217 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2218 "handshakes" : 79572, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2219 "handshakes_failed" : 21025, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2220 "session_reuses" : 15762, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2221 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2222 "no_common_cipher" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2223 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2224 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2225 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2226 "no_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2227 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2228 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2229 "hostname_mismatch" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2230 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2231 } |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2232 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2233 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2234 <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
|
2235 <para>Shared memory zone with slab allocator:</para> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2236 Shared memory zone with slab allocator<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
|
2237 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2238 <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
|
2239 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2240 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
|
2241 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2242 <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
|
2243 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2244 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2245 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
|
2246 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2247 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2248 <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
|
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 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2251 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
|
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 </list> |
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>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
|
2257 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2258 <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
|
2259 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2260 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2261 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2262 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2263 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2264 "pages" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2265 "used" : 1143, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2266 "free" : 2928 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2267 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2268 "slots" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2269 "8" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2270 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2271 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2272 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2273 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2274 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2275 "16" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2276 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2277 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2278 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2279 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2280 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2281 "32" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2282 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2283 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2284 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2285 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2286 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2287 "64" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2288 "used" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2289 "free" : 63, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2290 "reqs" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2291 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2292 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2293 "128" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2294 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2295 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2296 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2297 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2298 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2299 "256" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2300 "used" : 18078, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2301 "free" : 178, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2302 "reqs" : 1635736, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2303 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2304 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2305 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2306 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2307 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2308 <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
|
2309 <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
|
2310 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2311 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2312 <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
|
2313 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2314 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2315 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
|
2316 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2317 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2318 <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
|
2319 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2320 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2321 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
|
2322 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2323 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2324 <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
|
2325 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2326 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2327 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
|
2328 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2329 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2330 <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
|
2331 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2332 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2333 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
|
2334 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2335 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2336 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2337 <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
|
2338 <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
|
2339 <list type="tag"> |
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 <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
|
2342 </tag-name> |
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 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
|
2345 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2346 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2347 <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
|
2348 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2349 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2350 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
|
2351 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2352 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2353 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2354 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2355 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2356 "total" : 10624511, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2357 "current" : 4 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2358 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2359 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2360 <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
|
2361 <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
|
2362 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2363 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2364 <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
|
2365 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2366 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2367 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
|
2368 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2369 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2370 <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
|
2371 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2372 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2373 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
|
2374 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2375 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2376 <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
|
2377 <tag-desc> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2378 The total number of responses sent to clients, the number of responses with status codes “<literal>1xx</literal>”, “<literal>2xx</literal>”, “<literal>3xx</literal>”, “<literal>4xx</literal>”, and “<literal>5xx</literal>”, and the number of responses per each status code.<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
|
2379 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2380 <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
|
2381 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2382 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2383 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
|
2384 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2385 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2386 <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
|
2387 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2388 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2389 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
|
2390 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2391 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2392 <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
|
2393 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2394 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2395 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
|
2396 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2397 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2398 <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
|
2399 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2400 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2401 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
|
2402 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2403 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2404 <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
|
2405 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2406 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2407 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
|
2408 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2409 <tag-name> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2410 <literal>codes</literal></tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2411 <tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2412 The number of responses per each status code.<list type="tag"> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2413 <tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2414 <literal>codeNumber</literal> (<literal>integer</literal>) |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2415 </tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2416 <tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2417 The number of responses with this particular status code. |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2418 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2419 </list> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2420 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2421 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2422 <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
|
2423 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2424 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2425 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
|
2426 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2427 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2428 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2429 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2430 <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
|
2431 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2432 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2433 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
|
2434 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2435 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2436 <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
|
2437 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2438 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2439 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
|
2440 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2441 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2442 <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
|
2443 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2444 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2445 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
|
2446 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2447 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2448 <literal>ssl</literal></tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2449 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2450 <list type="tag"> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2451 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2452 <literal>handshakes</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2453 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2454 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2455 The total number of successful SSL handshakes. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2456 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2457 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2458 <literal>handshakes_failed</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2459 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2460 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2461 The total number of failed SSL handshakes. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2462 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2463 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2464 <literal>session_reuses</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2465 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2466 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2467 The total number of session reuses during SSL handshake. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2468 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2469 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2470 <literal>no_common_protocol</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2471 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2472 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2473 The number of SSL handshakes failed because of no common protocol. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2474 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2475 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2476 <literal>no_common_cipher</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2477 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2478 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2479 The number of SSL handshakes failed because of no shared cipher. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2480 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2481 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2482 <literal>handshake_timeout</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2483 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2484 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2485 The number of SSL handshakes failed because of a timeout. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2486 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2487 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2488 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2489 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2490 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2491 The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2492 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2493 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2494 <literal>verify_failures</literal></tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2495 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2496 SSL certificate verification errors<list type="tag"> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2497 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2498 <literal>no_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2499 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2500 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2501 A client did not provide the required certificate. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2502 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2503 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2504 <literal>expired_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2505 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2506 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2507 An expired or not yet valid certificate was presented by a client. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2508 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2509 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2510 <literal>revoked_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2511 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2512 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2513 A revoked certificate was presented by a client. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2514 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2515 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2516 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2517 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2518 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2519 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2520 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2521 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2522 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2523 </list> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2524 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2525 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2526 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2527 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2528 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2529 "processing" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2530 "requests" : 706690, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2531 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2532 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2533 "2xx" : 699482, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2534 "3xx" : 4522, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2535 "4xx" : 907, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2536 "5xx" : 266, |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2537 "codes" : { |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2538 "200" : 699482, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2539 "301" : 4522, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2540 "404" : 907, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2541 "503" : 266 |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2542 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2543 "total" : 705177 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2544 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2545 "discarded" : 1513, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2546 "received" : 172711587, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2547 "sent" : 19415530115, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2548 "ssl" : { |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2549 "handshakes" : 104303, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2550 "handshakes_failed" : 1421, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2551 "session_reuses" : 54645, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2552 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2553 "no_common_cipher" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2554 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2555 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2556 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2557 "no_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2558 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2559 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2560 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2561 } |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2562 } |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2563 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2564 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2565 <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
|
2566 <para>HTTP Location Zone:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2567 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2568 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2569 <literal>requests</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2570 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2571 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2572 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
|
2573 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2574 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2575 <literal>responses</literal></tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2576 <tag-desc> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2577 The total number of responses sent to clients, the number of responses with status codes “<literal>1xx</literal>”, “<literal>2xx</literal>”, “<literal>3xx</literal>”, “<literal>4xx</literal>”, and “<literal>5xx</literal>”, and the number of responses per each status code.<list type="tag"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2578 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2579 <literal>1xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2580 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2581 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2582 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
|
2583 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2584 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2585 <literal>2xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2586 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2587 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2588 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
|
2589 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2590 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2591 <literal>3xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2592 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2593 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2594 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
|
2595 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2596 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2597 <literal>4xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2598 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2599 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2600 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
|
2601 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2602 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2603 <literal>5xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2604 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2605 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2606 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
|
2607 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2608 <tag-name> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2609 <literal>codes</literal></tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2610 <tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2611 The number of responses per each status code.<list type="tag"> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2612 <tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2613 <literal>codeNumber</literal> (<literal>integer</literal>) |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2614 </tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2615 <tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2616 The number of responses with this particular status code. |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2617 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2618 </list> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2619 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2620 <tag-name> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2621 <literal>total</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2622 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2623 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2624 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
|
2625 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2626 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2627 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2628 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2629 <literal>discarded</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2630 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2631 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2632 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
|
2633 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2634 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2635 <literal>received</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2636 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2637 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2638 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
|
2639 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2640 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2641 <literal>sent</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2642 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2643 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2644 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
|
2645 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2646 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2647 <para>Example:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2648 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2649 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2650 "requests" : 706690, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2651 "responses" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2652 "1xx" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2653 "2xx" : 699482, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2654 "3xx" : 4522, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2655 "4xx" : 907, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2656 "5xx" : 266, |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2657 "codes" : { |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2658 "200" : 112674, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2659 "301" : 4522, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2660 "404" : 2504, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2661 "503" : 266 |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2662 }, |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2663 "total" : 705177 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2664 }, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2665 "discarded" : 1513, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2666 "received" : 172711587, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2667 "sent" : 19415530115 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2668 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2669 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2670 <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
|
2671 <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
|
2672 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2673 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2674 <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
|
2675 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2676 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2677 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
|
2678 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2679 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2680 <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
|
2681 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2682 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2683 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
|
2684 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2685 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2686 <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
|
2687 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2688 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2689 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
|
2690 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2691 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2692 <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
|
2693 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2694 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2695 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2696 <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
|
2697 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2698 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2699 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
|
2700 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2701 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2702 <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
|
2703 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2704 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2705 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
|
2706 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2707 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2708 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2709 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2710 <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
|
2711 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2712 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2713 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2714 <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
|
2715 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2716 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2717 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
|
2718 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2719 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2720 <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
|
2721 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2722 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2723 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
|
2724 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2725 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2726 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2727 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2728 <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
|
2729 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2730 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2731 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2732 <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
|
2733 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2734 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2735 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
|
2736 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2737 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2738 <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
|
2739 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2740 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2741 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
|
2742 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2743 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2744 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2745 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2746 <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
|
2747 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2748 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2749 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2750 <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
|
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 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2753 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
|
2754 </tag-desc> |
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>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
|
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 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
|
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 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2762 </tag-desc> |
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 <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
|
2765 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2766 <list type="tag"> |
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>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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2771 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
|
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>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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2777 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
|
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>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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2783 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
|
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>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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2789 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
|
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 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2792 </tag-desc> |
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 <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
|
2795 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2796 <list type="tag"> |
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>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
|
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 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
|
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>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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2807 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
|
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>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
|
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 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
|
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>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
|
2817 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2818 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2819 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
|
2820 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2821 </list> |
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 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2824 <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
|
2825 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2826 <list type="tag"> |
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 <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
|
2829 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2830 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2831 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
|
2832 </tag-desc> |
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 <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
|
2835 </tag-name> |
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 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
|
2838 </tag-desc> |
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 <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
|
2841 </tag-name> |
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 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
|
2844 </tag-desc> |
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 <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
|
2847 </tag-name> |
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 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
|
2850 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2851 </list> |
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 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2854 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2855 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2856 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2857 "size" : 530915328, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2858 "max_size" : 536870912, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2859 "cold" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2860 "hit" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2861 "responses" : 254032, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2862 "bytes" : 6685627875 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2863 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2864 "stale" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2865 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2866 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2867 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2868 "updating" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2869 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2870 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2871 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2872 "revalidated" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2873 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2874 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2875 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2876 "miss" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2877 "responses" : 1619201, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2878 "bytes" : 53841943822 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2879 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2880 "expired" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2881 "responses" : 45859, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2882 "bytes" : 1656847080, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2883 "responses_written" : 44992, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2884 "bytes_written" : 1641825173 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2885 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2886 "bypass" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2887 "responses" : 200187, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2888 "bytes" : 5510647548, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2889 "responses_written" : 200173, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2890 "bytes_written" : 44992 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2891 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2892 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2893 </listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2894 <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
|
2895 <para>HTTP Connections Limiting:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2896 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2897 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2898 <literal>passed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2899 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2900 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2901 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
|
2902 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2903 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2904 <literal>rejected</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2905 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2906 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2907 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
|
2908 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2909 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2910 <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
|
2911 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2912 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2913 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
|
2914 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2915 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2916 <para>Example:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2917 <example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2918 { |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2919 "passed" : 15, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2920 "rejected" : 0, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2921 "rejected_dry_run" : 2 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2922 }</example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2923 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2924 <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
|
2925 <para>HTTP Requests Rate Limiting:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2926 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2927 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2928 <literal>passed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2929 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2930 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2931 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
|
2932 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2933 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2934 <literal>delayed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2935 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2936 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2937 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
|
2938 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2939 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2940 <literal>rejected</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2941 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2942 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2943 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
|
2944 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2945 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2946 <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
|
2947 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2948 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2949 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
|
2950 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2951 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2952 <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
|
2953 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2954 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2955 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
|
2956 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2957 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2958 <para>Example:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2959 <example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2960 { |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2961 "passed" : 15, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2962 "delayed" : 4, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2963 "rejected" : 0, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2964 "delayed_dry_run" : 1, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2965 "rejected_dry_run" : 2 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2966 }</example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2967 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2968 <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
|
2969 <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
|
2970 <list type="tag"> |
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>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
|
2973 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2974 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
|
2975 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2976 <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
|
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 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2979 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
|
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 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2982 <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
|
2983 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2984 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2985 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
|
2986 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2987 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2988 <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
|
2989 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2990 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2991 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
|
2992 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2993 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2994 <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
|
2995 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2996 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2997 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
|
2998 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2999 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3000 <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
|
3001 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3002 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3003 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
|
3004 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3005 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3006 <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
|
3007 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3008 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3009 <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
|
3010 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3011 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3012 <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
|
3013 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3014 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3015 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
|
3016 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3017 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3018 <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
|
3019 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3020 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3021 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
|
3022 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3023 <tag-name> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3024 <literal>ssl</literal></tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3025 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3026 <list type="tag"> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3027 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3028 <literal>handshakes</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3029 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3030 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3031 The total number of successful SSL handshakes. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3032 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3033 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3034 <literal>handshakes_failed</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3035 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3036 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3037 The total number of failed SSL handshakes. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3038 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3039 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3040 <literal>session_reuses</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3041 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3042 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3043 The total number of session reuses during SSL handshake. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3044 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3045 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3046 <literal>no_common_protocol</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3047 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3048 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3049 The number of SSL handshakes failed because of no common protocol. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3050 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3051 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3052 <literal>handshake_timeout</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3053 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3054 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3055 The number of SSL handshakes failed because of a timeout. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3056 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3057 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3058 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3059 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3060 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3061 The number of failed SSL handshakes when nginx presented the certificate to the upstream server but it was rejected with a corresponding alert message. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3062 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3063 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3064 <literal>verify_failures</literal></tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3065 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3066 SSL certificate verification errors<list type="tag"> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3067 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3068 <literal>expired_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3069 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3070 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3071 An expired or not yet valid certificate was presented by an upstream server. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3072 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3073 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3074 <literal>revoked_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3075 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3076 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3077 A revoked certificate was presented by an upstream server. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3078 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3079 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3080 <literal>hostname_mismatch</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3081 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3082 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3083 Server's certificate doesn't match the hostname. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3084 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3085 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3086 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3087 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3088 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3089 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3090 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3091 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3092 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3093 </list> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3094 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3095 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3096 <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
|
3097 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3098 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3099 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
|
3100 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3101 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3102 <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
|
3103 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3104 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3105 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
|
3106 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3107 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3108 <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
|
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 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3111 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3112 <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
|
3113 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3114 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3115 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
|
3116 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3117 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3118 <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
|
3119 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3120 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3121 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
|
3122 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3123 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3124 <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
|
3125 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3126 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3127 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
|
3128 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3129 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3130 <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
|
3131 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3132 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3133 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
|
3134 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3135 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3136 <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
|
3137 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3138 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3139 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
|
3140 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3141 <tag-name> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3142 <literal>codes</literal></tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3143 <tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3144 The number of responses per each status code.<list type="tag"> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3145 <tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3146 <literal>codeNumber</literal> (<literal>integer</literal>) |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3147 </tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3148 <tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3149 The number of responses with this particular status code. |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3150 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3151 </list> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3152 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3153 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3154 <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
|
3155 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3156 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3157 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
|
3158 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3159 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3160 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3161 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3162 <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
|
3163 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3164 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3165 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
|
3166 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3167 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3168 <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
|
3169 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3170 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3171 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
|
3172 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3173 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3174 <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
|
3175 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3176 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3177 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
|
3178 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3179 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3180 <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
|
3181 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3182 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3183 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
|
3184 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3185 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3186 <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
|
3187 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3188 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3189 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3190 <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
|
3191 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3192 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3193 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
|
3194 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3195 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3196 <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
|
3197 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3198 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3199 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
|
3200 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3201 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3202 <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
|
3203 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3204 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3205 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
|
3206 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3207 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3208 <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
|
3209 </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 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
|
3212 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3213 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3214 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3215 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3216 <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
|
3217 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3218 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3219 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
|
3220 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3221 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3222 <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
|
3223 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3224 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3225 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
|
3226 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3227 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3228 <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
|
3229 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3230 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3231 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
|
3232 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3233 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3234 <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
|
3235 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3236 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3237 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
|
3238 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3239 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3240 <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
|
3241 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3242 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3243 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
|
3244 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3245 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3246 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3247 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3248 <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
|
3249 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3250 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3251 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
|
3252 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3253 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3254 <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
|
3255 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3256 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3257 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
|
3258 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3259 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3260 <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
|
3261 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3262 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3263 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
|
3264 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3265 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3266 <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
|
3267 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3268 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
|
3269 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3270 <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
|
3271 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3272 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3273 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
|
3274 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3275 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3276 <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
|
3277 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3278 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3279 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
|
3280 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3281 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3282 <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
|
3283 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3284 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3285 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
|
3286 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3287 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3288 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3289 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3290 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3291 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3292 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3293 "upstream_backend" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3294 "peers" : [ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3295 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3296 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3297 "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
|
3298 "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
|
3299 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3300 "weight" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3301 "state" : "up", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3302 "active" : 0, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3303 "ssl" : { |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3304 "handshakes" : 620311, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3305 "handshakes_failed" : 3432, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3306 "session_reuses" : 36442, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3307 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3308 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3309 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3310 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3311 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3312 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3313 "hostname_mismatch" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3314 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3315 } |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3316 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3317 "max_conns" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3318 "requests" : 667231, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3319 "header_time" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3320 "response_time" : 36, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3321 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3322 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3323 "2xx" : 666310, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3324 "3xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3325 "4xx" : 915, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3326 "5xx" : 6, |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3327 "codes" : { |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3328 "200" : 666310, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3329 "404" : 915, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3330 "503" : 6 |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3331 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3332 "total" : 667231 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3333 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3334 "sent" : 251946292, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3335 "received" : 19222475454, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3336 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3337 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3338 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3339 "checks" : 26214, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3340 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3341 "unhealthy" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3342 "last_passed" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3343 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3344 "downtime" : 0, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3345 "downstart" : "2022-06-28T11:09:21.602Z", |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3346 "selected" : "2022-06-28T15: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
|
3347 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3348 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3349 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3350 "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
|
3351 "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
|
3352 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3353 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3354 "state" : "unhealthy", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3355 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3356 "max_conns" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3357 "requests" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3358 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3359 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3360 "2xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3361 "3xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3362 "4xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3363 "5xx" : 0, |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3364 "codes" : { |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3365 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3366 "total" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3367 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3368 "sent" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3369 "received" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3370 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3371 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3372 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3373 "checks" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3374 "fails" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3375 "unhealthy" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3376 "last_passed" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3377 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3378 "downtime" : 262925617, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3379 "downstart" : "2022-06-28T11:09:21.602Z", |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3380 "selected" : "2022-06-28T15: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
|
3381 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3382 ], |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3383 "keepalive" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3384 "zombies" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3385 "zone" : "upstream_backend" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3386 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3387 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3388 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3389 <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
|
3390 <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
|
3391 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
|
3392 <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
|
3393 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3394 <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
|
3395 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3396 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3397 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
|
3398 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3399 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3400 <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
|
3401 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3402 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3403 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
|
3404 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3405 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3406 <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
|
3407 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3408 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3409 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
|
3410 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3411 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3412 <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
|
3413 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3414 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3415 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
|
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 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3418 <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
|
3419 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3420 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3421 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
|
3422 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3423 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3424 <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
|
3425 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3426 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3427 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
|
3428 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3429 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
3430 <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
|
3431 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3432 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3433 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
|
3434 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3435 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
3436 <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
|
3437 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3438 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3439 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
|
3440 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3441 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3442 <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
|
3443 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3444 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3445 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
|
3446 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3447 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3448 <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
|
3449 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3450 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3451 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
|
3452 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3453 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3454 <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
|
3455 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3456 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3457 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
|
3458 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3459 <tag-name> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3460 <literal>drain</literal> (<literal>boolean</literal>) |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3461 </tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3462 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3463 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
|
3464 </tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3465 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3466 <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
|
3467 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3468 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3469 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
|
3470 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3471 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3472 <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
|
3473 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3474 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3475 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
|
3476 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3477 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3478 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3479 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3480 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3481 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3482 "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
|
3483 "weight" : 4, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3484 "max_conns" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3485 "max_fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3486 "fail_timeout" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3487 "slow_start" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3488 "route" : "", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3489 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3490 "down" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3491 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3492 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3493 <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
|
3494 <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
|
3495 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
|
3496 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
|
3497 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3498 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3499 "key1" : "value1", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3500 "key2" : "value2", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3501 "key3" : "value3" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3502 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3503 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3504 <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
|
3505 <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
|
3506 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
|
3507 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
|
3508 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3509 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3510 "key1" : "value1", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3511 "key2" : "value2", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3512 "key3" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3513 "value" : "value3", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3514 "expire" : 30000 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3515 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3516 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3517 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3518 <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
|
3519 <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
|
3520 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3521 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3522 <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
|
3523 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3524 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3525 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
|
3526 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3527 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3528 <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
|
3529 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3530 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3531 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
|
3532 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3533 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3534 <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
|
3535 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3536 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
|
3537 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3538 <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
|
3539 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3540 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3541 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
|
3542 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3543 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3544 <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
|
3545 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3546 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3547 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
|
3548 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3549 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3550 <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
|
3551 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3552 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3553 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
|
3554 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3555 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3556 <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
|
3557 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3558 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3559 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
|
3560 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3561 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3562 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3563 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3564 <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
|
3565 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3566 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3567 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
|
3568 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3569 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3570 <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
|
3571 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3572 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3573 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
|
3574 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3575 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3576 <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
|
3577 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3578 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3579 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
|
3580 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3581 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3582 <literal>ssl</literal></tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3583 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3584 <list type="tag"> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3585 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3586 <literal>handshakes</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3587 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3588 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3589 The total number of successful SSL handshakes. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3590 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3591 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3592 <literal>handshakes_failed</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3593 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3594 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3595 The total number of failed SSL handshakes. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3596 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3597 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3598 <literal>session_reuses</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3599 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3600 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3601 The total number of session reuses during SSL handshake. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3602 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3603 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3604 <literal>no_common_protocol</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3605 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3606 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3607 The number of SSL handshakes failed because of no common protocol. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3608 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3609 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3610 <literal>no_common_cipher</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3611 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3612 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3613 The number of SSL handshakes failed because of no shared cipher. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3614 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3615 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3616 <literal>handshake_timeout</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3617 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3618 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3619 The number of SSL handshakes failed because of a timeout. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3620 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3621 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3622 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3623 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3624 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3625 The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3626 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3627 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3628 <literal>verify_failures</literal></tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3629 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3630 SSL certificate verification errors<list type="tag"> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3631 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3632 <literal>no_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3633 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3634 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3635 A client did not provide the required certificate. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3636 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3637 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3638 <literal>expired_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3639 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3640 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3641 An expired or not yet valid certificate was presented by a client. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3642 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3643 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3644 <literal>revoked_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3645 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3646 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3647 A revoked certificate was presented by a client. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3648 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3649 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3650 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3651 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3652 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3653 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3654 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3655 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3656 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3657 </list> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3658 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3659 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3660 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3661 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3662 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3663 "dns" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3664 "processing" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3665 "connections" : 155569, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3666 "sessions" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3667 "2xx" : 155564, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3668 "4xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3669 "5xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3670 "total" : 155569 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3671 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3672 "discarded" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3673 "received" : 4200363, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3674 "sent" : 20489184, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3675 "ssl" : { |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3676 "handshakes" : 76455, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3677 "handshakes_failed" : 432, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3678 "session_reuses" : 28770, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3679 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3680 "no_common_cipher" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3681 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3682 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3683 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3684 "no_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3685 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3686 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3687 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3688 } |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3689 } |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3690 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3691 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3692 </listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3693 <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
|
3694 <para>Stream Connections Limiting:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3695 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3696 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3697 <literal>passed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3698 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3699 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3700 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
|
3701 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3702 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3703 <literal>rejected</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3704 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3705 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3706 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
|
3707 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3708 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3709 <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
|
3710 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3711 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3712 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
|
3713 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3714 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3715 <para>Example:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3716 <example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3717 { |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3718 "passed" : 15, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3719 "rejected" : 0, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3720 "rejected_dry_run" : 2 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3721 }</example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3722 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3723 <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
|
3724 <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
|
3725 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3726 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3727 <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
|
3728 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3729 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
|
3730 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3731 <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
|
3732 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3733 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3734 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
|
3735 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3736 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3737 <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
|
3738 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3739 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3740 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
|
3741 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3742 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3743 <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
|
3744 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3745 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3746 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
|
3747 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3748 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3749 <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
|
3750 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3751 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3752 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
|
3753 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3754 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3755 <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
|
3756 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3757 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3758 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
|
3759 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3760 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3761 <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
|
3762 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3763 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3764 <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
|
3765 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3766 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3767 <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
|
3768 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3769 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3770 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
|
3771 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3772 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3773 <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
|
3774 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3775 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3776 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
|
3777 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3778 <tag-name> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3779 <literal>ssl</literal></tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3780 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3781 <list type="tag"> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3782 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3783 <literal>handshakes</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3784 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3785 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3786 The total number of successful SSL handshakes. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3787 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3788 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3789 <literal>handshakes_failed</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3790 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3791 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3792 The total number of failed SSL handshakes. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3793 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3794 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3795 <literal>session_reuses</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3796 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3797 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3798 The total number of session reuses during SSL handshake. |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3799 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3800 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3801 <literal>no_common_protocol</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3802 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3803 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3804 The number of SSL handshakes failed because of no common protocol. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3805 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3806 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3807 <literal>handshake_timeout</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3808 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3809 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3810 The number of SSL handshakes failed because of a timeout. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3811 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3812 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3813 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3814 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3815 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3816 The number of failed SSL handshakes when nginx presented the certificate to the upstream server but it was rejected with a corresponding alert message. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3817 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3818 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3819 <literal>verify_failures</literal></tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3820 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3821 SSL certificate verification errors<list type="tag"> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3822 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3823 <literal>expired_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3824 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3825 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3826 An expired or not yet valid certificate was presented by an upstream server. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3827 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3828 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3829 <literal>revoked_cert</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3830 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3831 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3832 A revoked certificate was presented by an upstream server. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3833 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3834 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3835 <literal>hostname_mismatch</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3836 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3837 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3838 Server's certificate doesn't match the hostname. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3839 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3840 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3841 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3842 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3843 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3844 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3845 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3846 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3847 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3848 </list> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3849 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3850 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3851 <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
|
3852 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3853 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3854 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
|
3855 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3856 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3857 <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
|
3858 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3859 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3860 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
|
3861 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3862 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3863 <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
|
3864 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3865 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3866 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
|
3867 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3868 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3869 <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
|
3870 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3871 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3872 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
|
3873 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3874 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3875 <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
|
3876 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3877 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3878 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
|
3879 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3880 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3881 <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
|
3882 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3883 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3884 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
|
3885 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3886 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3887 <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
|
3888 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3889 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3890 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
|
3891 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3892 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3893 <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
|
3894 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3895 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3896 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
|
3897 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3898 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3899 <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
|
3900 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3901 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3902 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
|
3903 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3904 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3905 <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
|
3906 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3907 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3908 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3909 <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
|
3910 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3911 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3912 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
|
3913 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3914 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3915 <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
|
3916 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3917 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3918 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
|
3919 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3920 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3921 <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
|
3922 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3923 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3924 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
|
3925 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3926 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3927 <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
|
3928 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3929 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3930 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
|
3931 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3932 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3933 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3934 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3935 <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
|
3936 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3937 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3938 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
|
3939 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3940 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3941 <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
|
3942 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3943 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3944 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
|
3945 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3946 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3947 <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
|
3948 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3949 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3950 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
|
3951 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3952 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3953 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3954 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3955 <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
|
3956 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3957 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3958 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
|
3959 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3960 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3961 <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
|
3962 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3963 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3964 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
|
3965 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3966 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3967 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3968 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3969 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3970 "dns" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3971 "peers" : [ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3972 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3973 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3974 "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
|
3975 "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
|
3976 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3977 "weight" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3978 "state" : "up", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3979 "active" : 0, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3980 "ssl" : { |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3981 "handshakes" : 200, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3982 "handshakes_failed" : 4, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3983 "session_reuses" : 189, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3984 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3985 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3986 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3987 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3988 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3989 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3990 "hostname_mismatch" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3991 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3992 } |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3993 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3994 "max_conns" : 50, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3995 "connections" : 667231, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3996 "sent" : 251946292, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3997 "received" : 19222475454, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3998 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3999 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4000 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4001 "checks" : 26214, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4002 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4003 "unhealthy" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4004 "last_passed" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4005 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4006 "downtime" : 0, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
4007 "downstart" : "2022-06-28T11:09:21.602Z", |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
4008 "selected" : "2022-06-28T15: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
|
4009 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4010 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4011 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4012 "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
|
4013 "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
|
4014 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4015 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4016 "state" : "unhealthy", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4017 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4018 "max_conns" : 50, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4019 "connections" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4020 "sent" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4021 "received" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4022 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4023 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4024 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4025 "checks" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4026 "fails" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4027 "unhealthy" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4028 "last_passed" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4029 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4030 "downtime" : 262925617, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
4031 "downstart" : "2022-06-28T11:09:21.602Z", |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
4032 "selected" : "2022-06-28T15: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
|
4033 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4034 ], |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4035 "zombies" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4036 "zone" : "dns" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4037 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4038 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4039 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4040 <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
|
4041 <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
|
4042 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
|
4043 <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
|
4044 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4045 <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
|
4046 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4047 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4048 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
|
4049 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4050 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4051 <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
|
4052 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4053 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4054 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
|
4055 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4056 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4057 <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
|
4058 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4059 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4060 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
|
4061 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4062 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4063 <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
|
4064 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4065 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4066 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
|
4067 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4068 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4069 <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
|
4070 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4071 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4072 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
|
4073 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4074 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4075 <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
|
4076 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4077 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4078 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
|
4079 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4080 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
4081 <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
|
4082 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4083 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4084 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
|
4085 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4086 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
4087 <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
|
4088 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4089 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4090 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
|
4091 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4092 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4093 <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
|
4094 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4095 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4096 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
|
4097 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4098 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4099 <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
|
4100 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4101 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4102 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
|
4103 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4104 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4105 <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
|
4106 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4107 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4108 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
|
4109 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4110 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4111 <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
|
4112 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4113 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4114 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
|
4115 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4116 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4117 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4118 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4119 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4120 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4121 "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
|
4122 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4123 "max_conns" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4124 "max_fails" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4125 "fail_timeout" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4126 "slow_start" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4127 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4128 "down" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4129 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4130 </listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4131 <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
|
4132 <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
|
4133 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
|
4134 <example> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4135 { |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4136 "key1" : "value1", |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4137 "key2" : "value2", |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4138 "key3" : "value3" |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4139 }</example> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4140 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4141 <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
|
4142 <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
|
4143 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
|
4144 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
|
4145 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4146 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4147 "key1" : "value1", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4148 "key2" : "value2", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4149 "key3" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4150 "value" : "value3", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4151 "expire" : 30000 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4152 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4153 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4154 </listitem> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4155 <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
|
4156 <para>Stream Zone Sync Node:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4157 <list type="tag"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4158 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4159 <literal>zones</literal></tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4160 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4161 <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
|
4162 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4163 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4164 <literal>status</literal></tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4165 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4166 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
|
4167 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4168 <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
|
4169 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4170 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4171 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
|
4172 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4173 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4174 <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
|
4175 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4176 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4177 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
|
4178 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4179 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4180 <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
|
4181 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4182 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4183 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
|
4184 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4185 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4186 <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
|
4187 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4188 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4189 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
|
4190 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4191 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4192 <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
|
4193 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4194 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4195 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
|
4196 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4197 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4198 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4199 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4200 <para>Example:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4201 <example> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4202 { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4203 "zones" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4204 "zone1" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4205 "records_pending" : 2061, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4206 "records_total" : 260575 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4207 }, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4208 "zone2" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4209 "records_pending" : 0, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4210 "records_total" : 14749 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4211 } |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4212 }, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4213 "status" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4214 "bytes_in" : 1364923761, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4215 "msgs_in" : 337236, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4216 "msgs_out" : 346717, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4217 "bytes_out" : 1402765472, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4218 "nodes_online" : 15 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4219 } |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4220 }</example> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4221 </listitem> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4222 <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
|
4223 <para>Sync Zone:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4224 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
|
4225 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4226 <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
|
4227 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4228 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4229 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
|
4230 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4231 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4232 <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
|
4233 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4234 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4235 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
|
4236 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4237 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4238 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4239 <listitem id="def_nginx_resolver_zone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4240 <para>Resolver Zone:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4241 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
|
4242 <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
|
4243 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4244 <literal>requests</literal></tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4245 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4246 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4247 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4248 <literal>name</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4249 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4250 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4251 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
|
4252 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4253 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4254 <literal>srv</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4255 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4256 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4257 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
|
4258 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4259 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4260 <literal>addr</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4261 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4262 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4263 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
|
4264 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4265 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4266 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4267 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4268 <literal>responses</literal></tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4269 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4270 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4271 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4272 <literal>noerror</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4273 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4274 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4275 The total number of successful responses. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4276 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4277 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4278 <literal>formerr</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4279 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4280 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4281 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
|
4282 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4283 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4284 <literal>servfail</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4285 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4286 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4287 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
|
4288 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4289 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4290 <literal>nxdomain</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4291 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4292 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4293 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
|
4294 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4295 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4296 <literal>notimp</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4297 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4298 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4299 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
|
4300 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4301 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4302 <literal>refused</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4303 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4304 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4305 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
|
4306 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4307 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4308 <literal>timedout</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4309 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4310 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4311 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
|
4312 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4313 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4314 <literal>unknown</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4315 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4316 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4317 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
|
4318 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4319 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4320 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4321 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4322 <para>Example:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4323 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4324 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4325 "resolver_zone1" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4326 "requests" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4327 "name" : 25460, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4328 "srv" : 130, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4329 "addr" : 2580 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4330 }, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4331 "responses" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4332 "noerror" : 26499, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4333 "formerr" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4334 "servfail" : 3, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4335 "nxdomain" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4336 "notimp" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4337 "refused" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4338 "timedout" : 243, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4339 "unknown" : 478 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4340 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4341 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4342 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4343 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4344 <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
|
4345 <para>Error:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4346 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
|
4347 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4348 <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
|
4349 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4350 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4351 <tag-name> |
2132
a645aa9f2ebf
Changed type of HTTP error code to integer in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2082
diff
changeset
|
4352 <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
|
4353 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4354 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4355 HTTP error code. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4356 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4357 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4358 <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
|
4359 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4360 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4361 Error description. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4362 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4363 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4364 <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
|
4365 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4366 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4367 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
|
4368 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4369 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4370 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4371 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4372 <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
|
4373 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4374 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4375 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
|
4376 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4377 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4378 <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
|
4379 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4380 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4381 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
|
4382 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4383 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4384 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4385 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4386 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4387 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4388 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4389 </module> |