Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_api_module.xml @ 2975:f8ad45c72992
nginx-1.25.1
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Tue, 13 Jun 2023 18:15:59 +0300 |
parents | a85e4d126bc7 |
children | 6e094f915896 |
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> |
2956
a85e4d126bc7
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2914
diff
changeset
|
211 Detailed failure counters were added to SSL statistics |
a85e4d126bc7
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2914
diff
changeset
|
212 in <link id="api_version">version</link> 8 (1.23.2). |
a85e4d126bc7
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2914
diff
changeset
|
213 </listitem> |
a85e4d126bc7
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2914
diff
changeset
|
214 |
a85e4d126bc7
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2914
diff
changeset
|
215 <listitem> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
216 The <literal>ssl</literal> data |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
217 for each HTTP |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
218 <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
|
219 <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
|
220 and stream |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
221 <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
|
222 <link id="def_nginx_stream_server_zone">server zone</link>, |
2956
a85e4d126bc7
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2914
diff
changeset
|
223 were added in <link id="api_version">version</link> 8 (1.21.6). |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
224 </listitem> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
225 |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
226 <listitem> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
227 The <literal>codes</literal> data |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
228 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
|
229 <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
|
230 <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
|
231 <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
|
232 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
|
233 </listitem> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
234 |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
235 <listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
236 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
|
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_conns_">/http/limit_conns/</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> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
246 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
|
247 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
|
248 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
249 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
250 <listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
251 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
|
252 <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
|
253 <link id="postHttpKeyvalZoneData">set</link> or |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
254 <link id="patchHttpKeyvalZoneKeyValue">changed</link> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
255 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
|
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="resolvers_">/resolvers/</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> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
264 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
|
265 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
|
266 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
267 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
268 <listitem> |
2359
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
269 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
|
270 <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
|
271 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
|
272 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
|
273 but show an empty value. |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
274 </listitem> |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
275 |
d5e576eb7677
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2253
diff
changeset
|
276 <listitem> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
277 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
|
278 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
|
279 </listitem> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
280 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
281 <listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
282 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
|
283 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
|
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 <listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
287 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
|
288 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
|
289 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
290 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
291 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
292 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
293 |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
294 </section> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
295 <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
|
296 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
297 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
298 <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
|
299 <literal>/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
300 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
301 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
302 <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
|
303 <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
|
304 <listitem id="getAPIEndpoints"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
305 <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
|
306 <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
|
307 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
308 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
309 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
310 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
311 <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
|
312 <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
|
313 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
314 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
315 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
316 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
317 <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
|
318 <literal>/nginx</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
319 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
320 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
321 <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
|
322 <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
|
323 <listitem id="getNginx"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
324 <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
|
325 <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
|
326 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
327 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
328 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
329 <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
|
330 (<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
|
331 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
332 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
|
333 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
334 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
335 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
336 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
337 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
338 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
339 <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
|
340 <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
|
341 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
342 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
343 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
344 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
345 <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
|
346 <literal>/processes</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
347 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
348 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
349 <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
|
350 <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
|
351 <listitem id="getProcesses"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
352 <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
|
353 <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
|
354 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
355 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
356 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
357 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
358 <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
|
359 <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
|
360 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
361 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
362 <listitem id="deleteProcesses"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
363 <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
|
364 <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
|
365 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
366 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
367 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
368 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
369 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
370 <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
|
371 <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
|
372 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
373 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
374 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
375 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
376 <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
|
377 <literal>/connections</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
378 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
379 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
380 <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
|
381 <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
|
382 <listitem id="getConnections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
383 <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
|
384 <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
|
385 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
386 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
387 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
388 <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
|
389 (<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
|
390 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
391 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
|
392 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
393 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
394 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
395 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
396 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
397 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
398 <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
|
399 <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
|
400 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
401 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
402 <listitem id="deleteConnections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
403 <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
|
404 <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
|
405 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
406 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
407 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
408 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
409 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
410 <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
|
411 <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
|
412 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
413 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
414 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
415 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
416 <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
|
417 <literal>/slabs/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
418 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
419 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
420 <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
|
421 <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
|
422 <listitem id="getSlabs"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
423 <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
|
424 <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
|
425 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
426 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
427 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
428 <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
|
429 (<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
|
430 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
431 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
|
432 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
433 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
434 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
435 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
436 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
437 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
438 <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
|
439 <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
|
440 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
441 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
442 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
443 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
444 <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
|
445 <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
|
446 </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 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
|
449 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
450 <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
|
451 (<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
|
452 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
453 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
|
454 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
455 <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
|
456 <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
|
457 <listitem id="getSlabZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
458 <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
|
459 <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
|
460 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
461 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
462 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
463 <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
|
464 (<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
|
465 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
466 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
|
467 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
468 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
469 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
470 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
471 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
472 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
473 <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
|
474 <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
|
475 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
|
476 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
477 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
478 <listitem id="deleteSlabZoneStats"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
479 <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
|
480 <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
|
481 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
482 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
483 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
484 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
485 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
486 <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
|
487 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
|
488 <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
|
489 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
490 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
491 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
492 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
493 <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
|
494 <literal>/http/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
495 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
496 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
497 <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
|
498 <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
|
499 <listitem id="getHttp"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
500 <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
|
501 <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
|
502 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
503 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
504 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
505 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
506 <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
|
507 <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
|
508 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
509 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
510 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
511 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
512 <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
|
513 <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
|
514 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
515 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
516 <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
|
517 <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
|
518 <listitem id="getHttpRequests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
519 <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
|
520 <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
|
521 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
522 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
523 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
524 <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
|
525 (<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
|
526 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
527 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
|
528 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
529 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
530 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
531 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
532 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
533 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
534 <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
|
535 <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
|
536 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
537 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
538 <listitem id="deleteHttpRequests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
539 <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
|
540 <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
|
541 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
542 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
543 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
544 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
545 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
546 <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
|
547 <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
|
548 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
549 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
550 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
551 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
552 <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
|
553 <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
|
554 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
555 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
556 <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
|
557 <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
|
558 <listitem id="getHttpServerZones"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
559 <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
|
560 <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
|
561 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
562 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
563 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
564 <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
|
565 (<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
|
566 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
567 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
|
568 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
569 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
570 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
571 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
572 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
573 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
574 <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
|
575 <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
|
576 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
577 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
578 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
579 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
580 <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
|
581 <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
|
582 </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 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
|
585 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
586 <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
|
587 (<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
|
588 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
589 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
|
590 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
591 <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
|
592 <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
|
593 <listitem id="getHttpServerZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
594 <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
|
595 <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
|
596 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
597 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
598 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
599 <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
|
600 (<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
|
601 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
602 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
|
603 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
604 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
605 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
606 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
607 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
608 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
609 <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
|
610 <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
|
611 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
|
612 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
613 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
614 <listitem id="deleteHttpServerZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
615 <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
|
616 <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
|
617 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
618 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
619 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
620 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
621 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
622 <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
|
623 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
|
624 <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
|
625 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
626 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
627 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
628 </tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
629 <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
|
630 <literal>/http/location_zones/</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
631 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
632 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
633 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
634 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
635 <listitem id="getHttpLocationZones"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
636 <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
|
637 <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
|
638 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
639 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
640 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
641 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
642 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
643 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
644 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
|
645 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
646 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
647 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
648 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
649 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
650 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
651 <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
|
652 <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
|
653 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
654 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
655 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
656 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
657 <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
|
658 <literal>/http/location_zones/{httpLocationZoneName}</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
659 </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 Parameters common for all methods: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
662 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
663 <tag-name><literal>httpLocationZoneName</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
664 (<literal>string</literal>, required)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
665 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
666 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
|
667 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
668 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
669 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
670 <listitem id="getHttpLocationZone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
671 <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
|
672 <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
|
673 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
674 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
675 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
676 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
677 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
678 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
679 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
|
680 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
681 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
682 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
683 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
684 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
685 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
686 <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
|
687 <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
|
688 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
|
689 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
690 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
691 <listitem id="deleteHttpLocationZoneStat"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
692 <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
|
693 <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
|
694 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
695 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
696 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
697 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
698 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
699 <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
|
700 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
|
701 <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
|
702 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
703 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
704 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
705 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
706 <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
|
707 <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
|
708 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
709 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
710 <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
|
711 <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
|
712 <listitem id="getHttpCaches"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
713 <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
|
714 <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
|
715 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
716 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
717 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
718 <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
|
719 (<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
|
720 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
721 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
|
722 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
723 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
724 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
725 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
726 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
727 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
728 <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
|
729 <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
|
730 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
731 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
732 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
733 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
734 <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
|
735 <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
|
736 </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 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
|
739 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
740 <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
|
741 (<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
|
742 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
743 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
|
744 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
745 <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
|
746 <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
|
747 <listitem id="getHttpCacheZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
748 <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
|
749 <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
|
750 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
751 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
752 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
753 <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
|
754 (<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
|
755 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
756 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
|
757 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
758 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
759 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
760 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
761 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
762 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
763 <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
|
764 <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
|
765 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
|
766 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
767 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
768 <listitem id="deleteHttpCacheZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
769 <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
|
770 <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
|
771 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
772 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
773 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
774 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
775 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
776 <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
|
777 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
|
778 <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
|
779 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
780 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
781 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
782 </tag-desc> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
783 <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
|
784 <literal>/http/limit_conns/</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
785 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
786 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
787 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
788 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
789 <listitem id="getHttpLimitConnZones"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
790 <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
|
791 <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
|
792 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
793 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
794 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
795 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
796 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
797 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
798 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
|
799 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
800 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
801 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
802 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
803 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
804 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
805 <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
|
806 <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
|
807 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
808 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
809 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
810 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
811 <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
|
812 <literal>/http/limit_conns/{httpLimitConnZoneName}</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
813 </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 Parameters common for all methods: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
816 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
817 <tag-name><literal>httpLimitConnZoneName</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
818 (<literal>string</literal>, required)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
819 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
820 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
|
821 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
822 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
823 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
824 <listitem id="getHttpLimitConnZone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
825 <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
|
826 <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
|
827 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
828 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
829 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
830 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
831 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
832 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
833 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
|
834 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
835 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
836 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
837 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
838 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
839 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
840 <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
|
841 <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
|
842 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
|
843 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
844 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
845 <listitem id="deleteHttpLimitConnZoneStat"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
846 <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
|
847 <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
|
848 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
849 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
850 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
851 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
852 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
853 <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
|
854 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
|
855 <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
|
856 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
857 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
858 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
859 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
860 <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
|
861 <literal>/http/limit_reqs/</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
862 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
863 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
864 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
865 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
866 <listitem id="getHttpLimitReqZones"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
867 <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
|
868 <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
|
869 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
870 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
871 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
872 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
873 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
874 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
875 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
|
876 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
877 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
878 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
879 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
880 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
881 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
882 <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
|
883 <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
|
884 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
885 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
886 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
887 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
888 <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
|
889 <literal>/http/limit_reqs/{httpLimitReqZoneName}</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
890 </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 Parameters common for all methods: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
893 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
894 <tag-name><literal>httpLimitReqZoneName</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
895 (<literal>string</literal>, required)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
896 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
897 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
|
898 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
899 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
900 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
901 <listitem id="getHttpLimitReqZone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
902 <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
|
903 <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
|
904 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
905 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
906 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
907 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
908 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
909 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
910 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
|
911 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
912 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
913 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
914 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
915 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
916 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
917 <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
|
918 <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
|
919 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
|
920 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
921 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
922 <listitem id="deleteHttpLimitReqZoneStat"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
923 <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
|
924 <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
|
925 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
926 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
927 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
928 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
929 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
930 <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
|
931 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
|
932 <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
|
933 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
934 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
935 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
936 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
937 <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
|
938 <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
|
939 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
940 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
941 <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
|
942 <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
|
943 <listitem id="getHttpUpstreams"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
944 <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
|
945 <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
|
946 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
947 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
948 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
949 <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
|
950 (<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
|
951 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
952 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
|
953 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
954 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
955 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
956 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
957 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
958 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
959 <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
|
960 <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
|
961 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
962 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
963 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
964 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
965 <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
|
966 <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
|
967 </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 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
|
970 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
971 <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
|
972 (<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
|
973 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
974 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
|
975 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
976 <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
|
977 <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
|
978 <listitem id="getHttpUpstreamName"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
979 <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
|
980 <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
|
981 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
982 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
983 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
984 <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
|
985 (<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
|
986 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
987 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
|
988 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
989 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
990 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
991 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
992 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
993 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
994 <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
|
995 <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
|
996 <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
|
997 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
|
998 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
999 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1000 <listitem id="deleteHttpUpstreamStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1001 <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
|
1002 <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
|
1003 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1004 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1005 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1006 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1007 <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
|
1008 <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
|
1009 <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
|
1010 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
|
1011 <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
|
1012 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1013 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1014 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1015 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1016 <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
|
1017 <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
|
1018 </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 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
|
1021 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1022 <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
|
1023 (<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
|
1024 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1025 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
|
1026 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1027 <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
|
1028 <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
|
1029 <listitem id="getHttpUpstreamServers"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1030 <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
|
1031 <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
|
1032 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1033 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1034 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1035 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1036 <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
|
1037 <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
|
1038 <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
|
1039 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
|
1040 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1041 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1042 <listitem id="postHttpUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1043 <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
|
1044 <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
|
1045 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1046 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1047 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1048 <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
|
1049 (<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
|
1050 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1051 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
|
1052 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1053 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1054 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1055 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1056 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1057 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1058 <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
|
1059 <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
|
1060 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
|
1061 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
|
1062 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
|
1063 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
|
1064 “<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
|
1065 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
|
1066 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
|
1067 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
|
1068 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
|
1069 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
|
1070 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
|
1071 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1072 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
|
1073 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
|
1074 “<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
|
1075 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
|
1076 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
|
1077 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
|
1078 <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
|
1079 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
|
1080 <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
|
1081 <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
|
1082 <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
|
1083 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1084 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1085 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1086 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1087 <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
|
1088 <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
|
1089 </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 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
|
1092 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1093 <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
|
1094 (<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
|
1095 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1096 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
|
1097 <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
|
1098 (<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
|
1099 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1100 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
|
1101 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1102 <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
|
1103 <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
|
1104 <listitem id="getHttpUpstreamPeer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1105 <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
|
1106 <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
|
1107 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1108 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1109 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1110 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1111 <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
|
1112 <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
|
1113 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
|
1114 <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
|
1115 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1116 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
|
1117 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1118 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1119 <listitem id="patchHttpUpstreamPeer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1120 <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
|
1121 <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
|
1122 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1123 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1124 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1125 <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
|
1126 (<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
|
1127 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1128 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
|
1129 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1130 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1131 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1132 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1133 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1134 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1135 <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
|
1136 <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
|
1137 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
|
1138 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
|
1139 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
|
1140 “<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
|
1141 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
|
1142 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
|
1143 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
|
1144 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
|
1145 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
|
1146 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
|
1147 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1148 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
|
1149 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
|
1150 “<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
|
1151 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
|
1152 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
|
1153 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
|
1154 <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
|
1155 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1156 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
|
1157 <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
|
1158 <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
|
1159 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1160 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1161 <listitem id="deleteHttpUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1162 <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
|
1163 <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
|
1164 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1165 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1166 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1167 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1168 <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
|
1169 <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
|
1170 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
|
1171 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
|
1172 <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
|
1173 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1174 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
|
1175 <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
|
1176 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1177 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1178 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1179 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1180 <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
|
1181 <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
|
1182 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1183 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1184 <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
|
1185 <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
|
1186 <listitem id="getHttpKeyvalZones"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1187 <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
|
1188 <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
|
1189 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1190 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1191 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1192 <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
|
1193 (<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
|
1194 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1195 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
|
1196 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1197 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1198 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1199 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1200 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1201 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1202 <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
|
1203 <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
|
1204 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1205 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1206 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1207 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1208 <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
|
1209 <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
|
1210 </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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1212 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
|
1213 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1214 <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
|
1215 (<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
|
1216 <tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1217 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
|
1218 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1219 <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
|
1220 <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
|
1221 <listitem id="getHttpKeyvalZoneKeysValues"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1222 <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
|
1223 <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
|
1224 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1225 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1226 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1227 <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
|
1228 (<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
|
1229 <tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1230 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
|
1231 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1232 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1233 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1234 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1235 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1236 <list type="bullet"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1237 <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
|
1238 <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
|
1239 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
|
1240 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
|
1241 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1242 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1243 <listitem id="postHttpKeyvalZoneData"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1244 <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
|
1245 <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
|
1246 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1247 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1248 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1249 <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
|
1250 (<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
|
1251 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1252 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
|
1253 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1254 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1255 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1256 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1257 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1258 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1259 <listitem>201 - Created</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1260 <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
|
1261 invalid key format (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1262 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1263 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1264 only one key can be added (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1265 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
|
1266 <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
|
1267 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
|
1268 <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
|
1269 <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
|
1270 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
|
1271 <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
|
1272 <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
|
1273 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1274 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1275 <listitem id="patchHttpKeyvalZoneKeyValue"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1276 <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
|
1277 <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
|
1278 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1279 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1280 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1281 <tag-name><literal>httpKeyvalZoneKeyValue</literal> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1282 (<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
|
1283 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1284 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
|
1285 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1286 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1287 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1288 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1289 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1290 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1291 <listitem>204 - Success</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1292 <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
|
1293 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1294 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1295 only one key can be updated (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1296 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
|
1297 <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
|
1298 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
|
1299 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
|
1300 <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
|
1301 <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
|
1302 <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
|
1303 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1304 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1305 <listitem id="deleteHttpKeyvalZoneData"> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1306 <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
|
1307 <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
|
1308 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1309 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1310 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1311 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1312 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1313 <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
|
1314 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
|
1315 <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
|
1316 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1317 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1318 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1319 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1320 <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
|
1321 <literal>/stream/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1322 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1323 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1324 <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
|
1325 <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
|
1326 <listitem id="getStream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1327 <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
|
1328 <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
|
1329 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1330 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1331 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1332 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1333 <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
|
1334 <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
|
1335 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1336 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1337 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1338 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1339 <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
|
1340 <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
|
1341 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1342 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1343 <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
|
1344 <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
|
1345 <listitem id="getStreamServerZones"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1346 <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
|
1347 <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
|
1348 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1349 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1350 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1351 <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
|
1352 (<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
|
1353 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1354 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
|
1355 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1356 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1357 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1358 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1359 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1360 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1361 <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
|
1362 <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
|
1363 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1364 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1365 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1366 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1367 <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
|
1368 <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
|
1369 </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 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
|
1372 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1373 <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
|
1374 (<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
|
1375 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1376 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
|
1377 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1378 <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
|
1379 <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
|
1380 <listitem id="getStreamServerZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1381 <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
|
1382 <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
|
1383 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1384 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1385 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1386 <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
|
1387 (<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
|
1388 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1389 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
|
1390 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1391 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1392 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1393 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1394 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1395 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1396 <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
|
1397 <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
|
1398 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
|
1399 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1400 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1401 <listitem id="deleteStreamServerZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1402 <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
|
1403 <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
|
1404 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1405 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1406 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1407 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1408 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1409 <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
|
1410 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
|
1411 <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
|
1412 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1413 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1414 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1415 </tag-desc> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1416 <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
|
1417 <literal>/stream/limit_conns/</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1418 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1419 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1420 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1421 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1422 <listitem id="getStreamLimitConnZones"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1423 <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
|
1424 <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
|
1425 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1426 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1427 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1428 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1429 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1430 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1431 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
|
1432 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1433 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1434 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1435 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1436 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1437 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1438 <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
|
1439 <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
|
1440 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1441 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1442 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1443 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1444 <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
|
1445 <literal>/stream/limit_conns/{streamLimitConnZoneName}</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1446 </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 Parameters common for all methods: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1449 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1450 <tag-name><literal>streamLimitConnZoneName</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1451 (<literal>string</literal>, required)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1452 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1453 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
|
1454 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1455 <para>Supported methods:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1456 <list type="bullet" compact="yes"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1457 <listitem id="getStreamLimitConnZone"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1458 <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
|
1459 <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
|
1460 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1461 Request parameters: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1462 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1463 <tag-name><literal>fields</literal> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1464 (<literal>string</literal>, optional)</tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1465 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1466 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
|
1467 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1468 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1469 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1470 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1471 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1472 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1473 <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
|
1474 <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
|
1475 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
|
1476 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1477 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1478 <listitem id="deleteStreamLimitConnZoneStat"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1479 <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
|
1480 <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
|
1481 <para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1482 Possible responses: |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1483 </para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1484 <list type="bullet"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1485 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1486 <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
|
1487 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
|
1488 <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
|
1489 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1490 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1491 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
1492 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1493 <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
|
1494 <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
|
1495 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1496 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1497 <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
|
1498 <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
|
1499 <listitem id="getStreamUpstreams"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1500 <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
|
1501 <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
|
1502 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1503 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1504 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1505 <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
|
1506 (<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
|
1507 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1508 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
|
1509 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1510 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1511 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1512 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1513 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1514 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1515 <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
|
1516 <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
|
1517 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1518 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1519 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1520 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1521 <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
|
1522 <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
|
1523 </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 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
|
1526 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1527 <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
|
1528 (<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
|
1529 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1530 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
|
1531 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1532 <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
|
1533 <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
|
1534 <listitem id="getStreamUpstream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1535 <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
|
1536 <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
|
1537 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1538 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1539 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1540 <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
|
1541 (<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
|
1542 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1543 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
|
1544 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1545 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1546 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1547 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1548 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1549 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1550 <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
|
1551 <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
|
1552 <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
|
1553 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
|
1554 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1555 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1556 <listitem id="deleteStreamUpstreamStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1557 <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
|
1558 <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
|
1559 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1560 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1561 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1562 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1563 <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
|
1564 <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
|
1565 <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
|
1566 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
|
1567 <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
|
1568 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1569 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1570 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1571 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1572 <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
|
1573 <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
|
1574 </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 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
|
1577 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1578 <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
|
1579 (<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
|
1580 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1581 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
|
1582 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1583 <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
|
1584 <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
|
1585 <listitem id="getStreamUpstreamServers"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1586 <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
|
1587 <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
|
1588 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1589 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1590 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1591 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1592 <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
|
1593 <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
|
1594 <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
|
1595 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
|
1596 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1597 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1598 <listitem id="postStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1599 <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
|
1600 <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
|
1601 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1602 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1603 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1604 <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
|
1605 (<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
|
1606 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1607 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
|
1608 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1609 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1610 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1611 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1612 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1613 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1614 <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
|
1615 <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
|
1616 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
|
1617 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
|
1618 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
|
1619 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
|
1620 “<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
|
1621 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
|
1622 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
|
1623 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
|
1624 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
|
1625 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
|
1626 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
|
1627 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
|
1628 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
|
1629 “<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
|
1630 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
|
1631 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
|
1632 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1633 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
|
1634 <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
|
1635 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
|
1636 <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
|
1637 <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
|
1638 <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
|
1639 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1640 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1641 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1642 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1643 <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
|
1644 <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
|
1645 </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 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
|
1648 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1649 <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
|
1650 (<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
|
1651 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1652 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
|
1653 <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
|
1654 (<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
|
1655 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1656 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
|
1657 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1658 <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
|
1659 <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
|
1660 <listitem id="getStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1661 <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
|
1662 <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
|
1663 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1664 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1665 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1666 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1667 <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
|
1668 <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
|
1669 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
|
1670 <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
|
1671 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
|
1672 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
|
1673 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1674 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1675 <listitem id="patchStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1676 <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
|
1677 <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
|
1678 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1679 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1680 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1681 <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
|
1682 (<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
|
1683 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1684 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
|
1685 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1686 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1687 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1688 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1689 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1690 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1691 <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
|
1692 <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
|
1693 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
|
1694 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
|
1695 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
|
1696 “<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
|
1697 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
|
1698 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
|
1699 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
|
1700 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
|
1701 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
|
1702 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
|
1703 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
|
1704 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1705 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
|
1706 “<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
|
1707 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
|
1708 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
|
1709 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
|
1710 <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
|
1711 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1712 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
|
1713 <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
|
1714 <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
|
1715 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1716 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1717 <listitem id="deleteStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1718 <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
|
1719 <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
|
1720 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1721 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1722 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1723 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1724 <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
|
1725 <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
|
1726 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
|
1727 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
|
1728 <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
|
1729 unknown version (<literal>UnknownVersion</literal>), |
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1730 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
|
1731 <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
|
1732 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1733 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1734 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1735 </tag-desc> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1736 <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
|
1737 <literal>/stream/keyvals/</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1738 </tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1739 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1740 <para>Supported methods:</para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1741 <list type="bullet" compact="yes"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1742 <listitem id="getStreamKeyvalZones"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1743 <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
|
1744 <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
|
1745 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1746 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1747 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1748 <tag-name><literal>fields</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1749 (<literal>string</literal>, optional)</tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1750 <tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1751 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
|
1752 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1753 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1754 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1755 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1756 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1757 <list type="bullet"> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1758 <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
|
1759 <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
|
1760 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1761 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1762 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1763 </tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1764 <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
|
1765 <literal>/stream/keyvals/{streamKeyvalZoneName}</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1766 </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 Parameters common for all methods: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1769 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1770 <tag-name><literal>streamKeyvalZoneName</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1771 (<literal>string</literal>, required)</tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1772 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1773 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
|
1774 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1775 <para>Supported methods:</para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1776 <list type="bullet" compact="yes"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1777 <listitem id="getStreamKeyvalZoneKeysValues"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1778 <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
|
1779 <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
|
1780 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1781 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1782 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1783 <tag-name><literal>key</literal> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1784 (<literal>string</literal>, optional)</tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1785 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1786 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
|
1787 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1788 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1789 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1790 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1791 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1792 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1793 <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
|
1794 <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
|
1795 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
|
1796 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
|
1797 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1798 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1799 <listitem id="postStreamKeyvalZoneData"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1800 <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
|
1801 <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
|
1802 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1803 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1804 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1805 <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
|
1806 (<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
|
1807 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1808 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
|
1809 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1810 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1811 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1812 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1813 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1814 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1815 <listitem>201 - Created</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1816 <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
|
1817 invalid key format (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1818 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1819 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1820 only one key can be added (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1821 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
|
1822 <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
|
1823 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
|
1824 <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
|
1825 <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
|
1826 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
|
1827 <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
|
1828 <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
|
1829 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1830 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1831 <listitem id="patchStreamKeyvalZoneKeyValue"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1832 <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
|
1833 <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
|
1834 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1835 Request parameters: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1836 <list type="tag"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1837 <tag-name><literal>streamKeyvalZoneKeyValue</literal> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1838 (<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
|
1839 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1840 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
|
1841 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1842 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1843 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1844 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1845 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1846 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1847 <listitem>204 - Success</listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1848 <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
|
1849 key required (<literal>KeyvalFormatError</literal>), |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1850 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), |
2494
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1851 only one key can be updated (<literal>KeyvalFormatError</literal>), |
78d4e25adf49
Documented "BodyReadError" in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2493
diff
changeset
|
1852 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
|
1853 <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
|
1854 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
|
1855 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
|
1856 <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
|
1857 <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
|
1858 <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
|
1859 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1860 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1861 <listitem id="deleteStreamKeyvalZoneData"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1862 <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
|
1863 <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
|
1864 <para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1865 Possible responses: |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1866 </para> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1867 <list type="bullet"> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1868 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1869 <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
|
1870 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
|
1871 <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
|
1872 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1873 </listitem> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1874 </list> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
1875 </tag-desc> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1876 <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
|
1877 <literal>/stream/zone_sync/</literal> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1878 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1879 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1880 <para>Supported methods:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1881 <list type="bullet" compact="yes"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1882 <listitem id="getStreamZoneSync"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1883 <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
|
1884 <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
|
1885 <para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1886 Possible responses: |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1887 </para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1888 <list type="bullet"> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1889 <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
|
1890 <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
|
1891 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1892 </listitem> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1893 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
1894 </tag-desc> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1895 <tag-name id="resolvers_" name="/resolvers/"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1896 <literal>/resolvers/</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1897 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1898 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1899 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1900 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1901 <listitem id="getResolverZones"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1902 <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
|
1903 <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
|
1904 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1905 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1906 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1907 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1908 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1909 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1910 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
|
1911 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1912 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1913 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1914 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1915 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1916 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1917 <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
|
1918 <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
|
1919 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1920 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1921 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1922 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1923 <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
|
1924 <literal>/resolvers/{resolverZoneName}</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1925 </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 Parameters common for all methods: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1928 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1929 <tag-name><literal>resolverZoneName</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1930 (<literal>string</literal>, required)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1931 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1932 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
|
1933 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1934 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1935 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1936 <listitem id="getResolverZone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1937 <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
|
1938 <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
|
1939 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1940 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1941 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1942 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1943 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1944 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1945 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
|
1946 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1947 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1948 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1949 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1950 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1951 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1952 <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
|
1953 <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
|
1954 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
|
1955 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1956 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1957 <listitem id="deleteResolverZoneStat"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1958 <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
|
1959 <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
|
1960 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1961 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1962 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1963 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1964 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
1965 <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
|
1966 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
|
1967 <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
|
1968 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1969 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1970 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1971 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1972 <tag-name id="ssl" name="/ssl"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1973 <literal>/ssl</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1974 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1975 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1976 <para>Supported methods:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1977 <list type="bullet" compact="yes"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1978 <listitem id="getSsl"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1979 <literal>GET</literal> - Return SSL statistics |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1980 <para>Returns SSL statistics.</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1981 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1982 Request parameters: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1983 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1984 <tag-name><literal>fields</literal> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1985 (<literal>string</literal>, optional)</tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1986 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1987 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
|
1988 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1989 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1990 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1991 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1992 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1993 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1994 <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
|
1995 <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
|
1996 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1997 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1998 <listitem id="deleteSslStat"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
1999 <literal>DELETE</literal> - Reset SSL statistics |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2000 <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
|
2001 <para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2002 Possible responses: |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2003 </para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2004 <list type="bullet"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2005 <listitem>204 - Success</listitem> |
2499
20dbb29cbe05
Documented the "Unknown version" error in the API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2494
diff
changeset
|
2006 <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
|
2007 <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
|
2008 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2009 </listitem> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2010 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2011 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2012 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2013 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2014 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2015 <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
|
2016 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2017 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2018 <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
|
2019 <para>nginx:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2020 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
|
2021 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2022 <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
|
2023 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2024 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2025 Version of nginx. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2026 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2027 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2028 <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
|
2029 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2030 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2031 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
|
2032 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2033 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2034 <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
|
2035 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2036 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2037 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
|
2038 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2039 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2040 <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
|
2041 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2042 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2043 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
|
2044 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2045 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2046 <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
|
2047 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2048 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
2049 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
|
2050 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2051 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2052 <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
|
2053 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2054 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
2055 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
|
2056 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2057 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2058 <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
|
2059 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2060 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2061 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
|
2062 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2063 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2064 <literal>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
|
2065 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2066 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2067 The 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
|
2068 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2069 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2070 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2071 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2072 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2073 "nginx" : { |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2074 "version" : "1.21.6", |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2075 "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
|
2076 "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
|
2077 "generation" : 6, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2078 "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
|
2079 "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
|
2080 "pid" : 32212, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2081 "ppid" : 32210 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2082 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2083 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2084 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2085 <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
|
2086 <para>Processes:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2087 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2088 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2089 <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
|
2090 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2091 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2092 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
|
2093 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2094 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2095 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2096 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2097 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2098 "respawned" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2099 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2100 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2101 <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
|
2102 <para>Connections:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2103 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
|
2104 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2105 <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
|
2106 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2107 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2108 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
|
2109 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2110 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2111 <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
|
2112 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2113 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2114 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
|
2115 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2116 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2117 <literal>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
|
2118 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2119 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2120 The 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
|
2121 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2122 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2123 <literal>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
|
2124 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2125 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2126 The 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
|
2127 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2128 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2129 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2130 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2131 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2132 "accepted" : 4968119, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2133 "dropped" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2134 "active" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2135 "idle" : 117 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2136 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2137 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2138 <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
|
2139 <para>SSL:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2140 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2141 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2142 <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
|
2143 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2144 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2145 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
|
2146 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2147 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2148 <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
|
2149 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2150 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2151 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
|
2152 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2153 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2154 <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
|
2155 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2156 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2157 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
|
2158 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2159 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2160 <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
|
2161 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2162 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2163 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
|
2164 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2165 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2166 <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
|
2167 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2168 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2169 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
|
2170 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2171 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2172 <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
|
2173 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2174 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2175 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
|
2176 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2177 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2178 <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
|
2179 </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 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
|
2182 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2183 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2184 <literal>verify_failures</literal></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 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
|
2187 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2188 <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
|
2189 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2190 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2191 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
|
2192 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2193 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2194 <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
|
2195 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2196 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2197 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
|
2198 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2199 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2200 <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
|
2201 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2202 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2203 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
|
2204 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2205 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2206 <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
|
2207 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2208 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2209 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
|
2210 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2211 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2212 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2213 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2214 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2215 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2216 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2217 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2218 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2219 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2220 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2221 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2222 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2223 "handshakes" : 79572, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2224 "handshakes_failed" : 21025, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2225 "session_reuses" : 15762, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2226 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2227 "no_common_cipher" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2228 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2229 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2230 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2231 "no_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2232 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2233 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2234 "hostname_mismatch" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2235 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2236 } |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2237 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2238 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2239 <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
|
2240 <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
|
2241 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
|
2242 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2243 <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
|
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 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
|
2246 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2247 <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
|
2248 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2249 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2250 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
|
2251 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2252 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2253 <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
|
2254 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2255 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2256 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
|
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 </list> |
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 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2261 <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
|
2262 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2263 <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
|
2264 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2265 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2266 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2267 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2268 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2269 "pages" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2270 "used" : 1143, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2271 "free" : 2928 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2272 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2273 "slots" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2274 "8" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2275 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2276 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2277 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2278 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2279 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2280 "16" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2281 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2282 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2283 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2284 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2285 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2286 "32" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2287 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2288 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2289 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2290 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2291 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2292 "64" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2293 "used" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2294 "free" : 63, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2295 "reqs" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2296 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2297 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2298 "128" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2299 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2300 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2301 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2302 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2303 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2304 "256" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2305 "used" : 18078, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2306 "free" : 178, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2307 "reqs" : 1635736, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2308 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2309 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2310 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2311 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2312 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2313 <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
|
2314 <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
|
2315 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2316 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2317 <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
|
2318 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2319 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2320 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
|
2321 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2322 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2323 <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
|
2324 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2325 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2326 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
|
2327 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2328 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2329 <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
|
2330 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2331 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2332 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
|
2333 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2334 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2335 <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
|
2336 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2337 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2338 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
|
2339 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2340 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2341 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2342 <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
|
2343 <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
|
2344 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2345 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2346 <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
|
2347 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2348 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2349 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
|
2350 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2351 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2352 <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
|
2353 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2354 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2355 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
|
2356 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2357 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2358 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2359 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2360 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2361 "total" : 10624511, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2362 "current" : 4 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2363 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2364 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2365 <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
|
2366 <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
|
2367 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2368 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2369 <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
|
2370 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2371 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2372 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
|
2373 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2374 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2375 <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
|
2376 </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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2378 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
|
2379 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2380 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2381 <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
|
2382 <tag-desc> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2383 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
|
2384 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2385 <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
|
2386 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2387 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2388 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
|
2389 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2390 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2391 <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
|
2392 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2393 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2394 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
|
2395 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2396 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2397 <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
|
2398 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2399 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2400 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
|
2401 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2402 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2403 <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
|
2404 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2405 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2406 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
|
2407 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2408 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2409 <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
|
2410 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2411 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2412 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
|
2413 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2414 <tag-name> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2415 <literal>codes</literal></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 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
|
2418 <tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2419 <literal>codeNumber</literal> (<literal>integer</literal>) |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2420 </tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2421 <tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2422 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
|
2423 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2424 </list> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2425 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2426 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2427 <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
|
2428 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2429 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2430 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
|
2431 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2432 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2433 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2434 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2435 <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
|
2436 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2437 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2438 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
|
2439 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2440 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2441 <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
|
2442 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2443 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2444 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
|
2445 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2446 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2447 <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
|
2448 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2449 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2450 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
|
2451 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2452 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2453 <literal>ssl</literal></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 <list type="tag"> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2456 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2457 <literal>handshakes</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2458 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2459 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2460 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
|
2461 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2462 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2463 <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
|
2464 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2465 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2466 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
|
2467 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2468 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2469 <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
|
2470 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2471 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2472 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
|
2473 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2474 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2475 <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
|
2476 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2477 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2478 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
|
2479 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2480 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2481 <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
|
2482 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2483 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2484 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
|
2485 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2486 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2487 <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
|
2488 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2489 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2490 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
|
2491 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2492 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2493 <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
|
2494 </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 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
|
2497 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2498 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2499 <literal>verify_failures</literal></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 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
|
2502 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2503 <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
|
2504 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2505 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2506 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
|
2507 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2508 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2509 <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
|
2510 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2511 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2512 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
|
2513 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2514 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2515 <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
|
2516 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2517 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2518 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
|
2519 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2520 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2521 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2522 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2523 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2524 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2525 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2526 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2527 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2528 </list> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2529 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2530 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2531 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2532 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2533 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2534 "processing" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2535 "requests" : 706690, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2536 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2537 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2538 "2xx" : 699482, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2539 "3xx" : 4522, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2540 "4xx" : 907, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2541 "5xx" : 266, |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2542 "codes" : { |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2543 "200" : 699482, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2544 "301" : 4522, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2545 "404" : 907, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2546 "503" : 266 |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2547 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2548 "total" : 705177 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2549 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2550 "discarded" : 1513, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2551 "received" : 172711587, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2552 "sent" : 19415530115, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2553 "ssl" : { |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2554 "handshakes" : 104303, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2555 "handshakes_failed" : 1421, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2556 "session_reuses" : 54645, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2557 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2558 "no_common_cipher" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2559 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2560 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2561 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2562 "no_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2563 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2564 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2565 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
2566 } |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
2567 } |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2568 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2569 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2570 <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
|
2571 <para>HTTP Location Zone:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2572 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2573 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2574 <literal>requests</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2575 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2576 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2577 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
|
2578 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2579 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2580 <literal>responses</literal></tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2581 <tag-desc> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2582 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
|
2583 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2584 <literal>1xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2585 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2586 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2587 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
|
2588 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2589 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2590 <literal>2xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2591 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2592 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2593 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
|
2594 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2595 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2596 <literal>3xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2597 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2598 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2599 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
|
2600 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2601 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2602 <literal>4xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2603 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2604 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2605 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
|
2606 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2607 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2608 <literal>5xx</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2609 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2610 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2611 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
|
2612 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2613 <tag-name> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2614 <literal>codes</literal></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 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
|
2617 <tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2618 <literal>codeNumber</literal> (<literal>integer</literal>) |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2619 </tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2620 <tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2621 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
|
2622 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2623 </list> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2624 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2625 <tag-name> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2626 <literal>total</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2627 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2628 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2629 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
|
2630 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2631 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2632 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2633 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2634 <literal>discarded</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2635 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2636 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2637 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
|
2638 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2639 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2640 <literal>received</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2641 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2642 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2643 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
|
2644 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2645 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2646 <literal>sent</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2647 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2648 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2649 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
|
2650 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2651 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2652 <para>Example:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2653 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2654 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2655 "requests" : 706690, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2656 "responses" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2657 "1xx" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2658 "2xx" : 699482, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2659 "3xx" : 4522, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2660 "4xx" : 907, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2661 "5xx" : 266, |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2662 "codes" : { |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2663 "200" : 112674, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2664 "301" : 4522, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2665 "404" : 2504, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2666 "503" : 266 |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
2667 }, |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2668 "total" : 705177 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2669 }, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2670 "discarded" : 1513, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2671 "received" : 172711587, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2672 "sent" : 19415530115 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2673 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
2674 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2675 <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
|
2676 <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
|
2677 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2678 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2679 <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
|
2680 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2681 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2682 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
|
2683 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2684 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2685 <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
|
2686 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2687 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2688 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
|
2689 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2690 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2691 <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
|
2692 </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> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2694 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
|
2695 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2696 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2697 <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
|
2698 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2699 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2700 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2701 <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
|
2702 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2703 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2704 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
|
2705 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2706 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2707 <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
|
2708 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2709 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2710 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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2713 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2714 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2715 <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
|
2716 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2717 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2718 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2719 <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
|
2720 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2721 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2722 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
|
2723 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2724 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2725 <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
|
2726 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2727 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2728 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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2731 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2732 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2733 <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
|
2734 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2735 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2736 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2737 <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
|
2738 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2739 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2740 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
|
2741 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2742 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2743 <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
|
2744 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2745 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2746 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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2749 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2750 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2751 <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
|
2752 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2753 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2754 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2755 <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
|
2756 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2757 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2758 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
|
2759 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2760 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2761 <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
|
2762 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2763 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2764 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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2767 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2768 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2769 <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
|
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 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2772 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2773 <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
|
2774 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2775 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2776 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
|
2777 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2778 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2779 <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
|
2780 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2781 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2782 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
|
2783 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2784 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2785 <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
|
2786 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2787 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2788 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
|
2789 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2790 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2791 <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
|
2792 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2793 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2794 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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2797 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2798 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2799 <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
|
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 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2802 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2803 <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
|
2804 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2805 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2806 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
|
2807 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2808 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2809 <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
|
2810 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2811 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2812 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
|
2813 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2814 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2815 <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
|
2816 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2817 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2818 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
|
2819 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2820 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2821 <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
|
2822 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2823 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2824 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
|
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2827 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2828 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2829 <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
|
2830 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2831 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2832 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2833 <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
|
2834 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2835 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2836 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
|
2837 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2838 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2839 <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
|
2840 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2841 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2842 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
|
2843 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2844 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2845 <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
|
2846 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2847 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2848 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
|
2849 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2850 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2851 <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
|
2852 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2853 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2854 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
|
2855 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2856 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2857 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2858 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2859 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2860 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2861 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2862 "size" : 530915328, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2863 "max_size" : 536870912, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2864 "cold" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2865 "hit" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2866 "responses" : 254032, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2867 "bytes" : 6685627875 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2868 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2869 "stale" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2870 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2871 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2872 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2873 "updating" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2874 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2875 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2876 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2877 "revalidated" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2878 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2879 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2880 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2881 "miss" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2882 "responses" : 1619201, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2883 "bytes" : 53841943822 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2884 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2885 "expired" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2886 "responses" : 45859, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2887 "bytes" : 1656847080, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2888 "responses_written" : 44992, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2889 "bytes_written" : 1641825173 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2890 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2891 "bypass" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2892 "responses" : 200187, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2893 "bytes" : 5510647548, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2894 "responses_written" : 200173, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2895 "bytes_written" : 44992 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2896 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2897 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2898 </listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2899 <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
|
2900 <para>HTTP Connections Limiting:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2901 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2902 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2903 <literal>passed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2904 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2905 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2906 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
|
2907 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2908 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2909 <literal>rejected</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2910 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2911 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2912 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
|
2913 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2914 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2915 <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
|
2916 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2917 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2918 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
|
2919 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2920 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2921 <para>Example:</para> |
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 { |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2924 "passed" : 15, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2925 "rejected" : 0, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2926 "rejected_dry_run" : 2 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2927 }</example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2928 </listitem> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2929 <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
|
2930 <para>HTTP Requests Rate Limiting:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2931 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2932 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2933 <literal>passed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2934 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2935 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2936 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
|
2937 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2938 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2939 <literal>delayed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2940 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2941 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2942 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
|
2943 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2944 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2945 <literal>rejected</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2946 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2947 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2948 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
|
2949 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2950 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2951 <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
|
2952 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2953 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2954 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
|
2955 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2956 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2957 <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
|
2958 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2959 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2960 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
|
2961 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2962 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2963 <para>Example:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2964 <example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2965 { |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2966 "passed" : 15, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2967 "delayed" : 4, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2968 "rejected" : 0, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2969 "delayed_dry_run" : 1, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2970 "rejected_dry_run" : 2 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2971 }</example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
2972 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2973 <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
|
2974 <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
|
2975 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2976 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2977 <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
|
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 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
|
2980 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2981 <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
|
2982 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2983 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2984 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
|
2985 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2986 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2987 <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
|
2988 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2989 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2990 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
|
2991 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2992 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2993 <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
|
2994 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2995 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2996 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
|
2997 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2998 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2999 <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
|
3000 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3001 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3002 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
|
3003 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3004 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3005 <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
|
3006 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3007 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3008 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
|
3009 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3010 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3011 <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
|
3012 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3013 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3014 <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
|
3015 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3016 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3017 <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
|
3018 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3019 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3020 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
|
3021 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3022 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3023 <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
|
3024 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3025 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3026 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
|
3027 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3028 <tag-name> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3029 <literal>ssl</literal></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 <list type="tag"> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3032 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3033 <literal>handshakes</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3034 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3035 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3036 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
|
3037 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3038 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3039 <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
|
3040 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3041 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3042 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
|
3043 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3044 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3045 <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
|
3046 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3047 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3048 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
|
3049 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3050 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3051 <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
|
3052 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3053 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3054 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
|
3055 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3056 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3057 <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
|
3058 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3059 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3060 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
|
3061 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3062 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3063 <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
|
3064 </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 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
|
3067 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3068 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3069 <literal>verify_failures</literal></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 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
|
3072 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3073 <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
|
3074 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3075 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3076 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
|
3077 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3078 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3079 <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
|
3080 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3081 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3082 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
|
3083 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3084 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3085 <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
|
3086 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3087 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3088 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
|
3089 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3090 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3091 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3092 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3093 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3094 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3095 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3096 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3097 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3098 </list> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3099 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3100 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3101 <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
|
3102 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3103 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3104 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
|
3105 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3106 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3107 <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
|
3108 </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 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
|
3111 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3112 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3113 <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
|
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 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3116 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3117 <literal>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
|
3118 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3119 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3120 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
|
3121 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3122 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3123 <literal>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
|
3124 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3125 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3126 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
|
3127 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3128 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3129 <literal>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
|
3130 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3131 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3132 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
|
3133 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3134 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3135 <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
|
3136 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3137 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3138 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
|
3139 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3140 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3141 <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
|
3142 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3143 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3144 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
|
3145 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3146 <tag-name> |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3147 <literal>codes</literal></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 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
|
3150 <tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3151 <literal>codeNumber</literal> (<literal>integer</literal>) |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3152 </tag-name> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3153 <tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3154 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
|
3155 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3156 </list> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3157 </tag-desc> |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3158 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3159 <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
|
3160 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3161 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3162 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
|
3163 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3164 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3165 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3166 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3167 <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
|
3168 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3169 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3170 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
|
3171 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3172 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3173 <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
|
3174 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3175 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3176 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
|
3177 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3178 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3179 <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
|
3180 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3181 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3182 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
|
3183 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3184 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3185 <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
|
3186 </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> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3188 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
|
3189 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3190 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3191 <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
|
3192 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3193 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3194 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3195 <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
|
3196 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3197 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3198 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
|
3199 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3200 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3201 <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
|
3202 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3203 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3204 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
|
3205 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3206 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3207 <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
|
3208 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3209 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3210 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
|
3211 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3212 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3213 <literal>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
|
3214 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3215 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3216 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
|
3217 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3218 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3219 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3220 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3221 <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
|
3222 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3223 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3224 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
|
3225 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3226 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3227 <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
|
3228 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3229 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3230 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
|
3231 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3232 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3233 <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
|
3234 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3235 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3236 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
|
3237 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3238 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3239 <literal>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
|
3240 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3241 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3242 The 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
|
3243 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3244 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3245 <literal>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
|
3246 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3247 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3248 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
|
3249 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3250 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3251 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3252 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3253 <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
|
3254 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3255 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3256 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
|
3257 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3258 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3259 <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
|
3260 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3261 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3262 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
|
3263 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3264 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3265 <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
|
3266 </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 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
|
3269 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3270 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3271 <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
|
3272 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3273 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
|
3274 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3275 <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
|
3276 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3277 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3278 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
|
3279 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3280 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3281 <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
|
3282 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3283 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3284 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
|
3285 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3286 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3287 <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
|
3288 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3289 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3290 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
|
3291 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3292 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3293 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3294 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3295 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3296 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3297 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3298 "upstream_backend" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3299 "peers" : [ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3300 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3301 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3302 "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
|
3303 "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
|
3304 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3305 "weight" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3306 "state" : "up", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3307 "active" : 0, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3308 "ssl" : { |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3309 "handshakes" : 620311, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3310 "handshakes_failed" : 3432, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3311 "session_reuses" : 36442, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3312 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3313 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3314 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3315 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3316 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3317 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3318 "hostname_mismatch" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3319 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3320 } |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3321 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3322 "max_conns" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3323 "requests" : 667231, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3324 "header_time" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3325 "response_time" : 36, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3326 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3327 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3328 "2xx" : 666310, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3329 "3xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3330 "4xx" : 915, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3331 "5xx" : 6, |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3332 "codes" : { |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3333 "200" : 666310, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3334 "404" : 915, |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3335 "503" : 6 |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3336 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3337 "total" : 667231 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3338 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3339 "sent" : 251946292, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3340 "received" : 19222475454, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3341 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3342 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3343 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3344 "checks" : 26214, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3345 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3346 "unhealthy" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3347 "last_passed" : true |
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 "downtime" : 0, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3350 "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
|
3351 "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
|
3352 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3353 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3354 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3355 "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
|
3356 "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
|
3357 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3358 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3359 "state" : "unhealthy", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3360 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3361 "max_conns" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3362 "requests" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3363 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3364 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3365 "2xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3366 "3xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3367 "4xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3368 "5xx" : 0, |
2768
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3369 "codes" : { |
9dd8c203a54a
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2501
diff
changeset
|
3370 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3371 "total" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3372 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3373 "sent" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3374 "received" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3375 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3376 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3377 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3378 "checks" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3379 "fails" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3380 "unhealthy" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3381 "last_passed" : false |
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 "downtime" : 262925617, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3384 "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
|
3385 "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
|
3386 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3387 ], |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3388 "keepalive" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3389 "zombies" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3390 "zone" : "upstream_backend" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3391 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3392 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3393 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3394 <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
|
3395 <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
|
3396 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
|
3397 <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
|
3398 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3399 <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
|
3400 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3401 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3402 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
|
3403 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3404 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3405 <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
|
3406 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3407 <tag-desc> |
2956
a85e4d126bc7
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2914
diff
changeset
|
3408 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">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
|
3409 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3410 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3411 <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
|
3412 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3413 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3414 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
|
3415 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3416 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3417 <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
|
3418 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3419 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3420 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
|
3421 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3422 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3423 <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
|
3424 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3425 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3426 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
|
3427 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3428 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3429 <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
|
3430 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3431 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3432 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
|
3433 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3434 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
3435 <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
|
3436 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3437 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3438 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
|
3439 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3440 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
3441 <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
|
3442 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3443 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3444 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
|
3445 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3446 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3447 <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
|
3448 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3449 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3450 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
|
3451 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3452 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3453 <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
|
3454 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3455 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3456 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
|
3457 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3458 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3459 <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
|
3460 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3461 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3462 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
|
3463 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3464 <tag-name> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3465 <literal>drain</literal> (<literal>boolean</literal>) |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3466 </tag-name> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3467 <tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3468 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
|
3469 </tag-desc> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
3470 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3471 <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
|
3472 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3473 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3474 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
|
3475 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3476 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3477 <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
|
3478 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3479 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3480 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
|
3481 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3482 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3483 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3484 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3485 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3486 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3487 "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
|
3488 "weight" : 4, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3489 "max_conns" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3490 "max_fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3491 "fail_timeout" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3492 "slow_start" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3493 "route" : "", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3494 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3495 "down" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3496 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3497 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3498 <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
|
3499 <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
|
3500 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
|
3501 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
|
3502 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3503 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3504 "key1" : "value1", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3505 "key2" : "value2", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3506 "key3" : "value3" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3507 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3508 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3509 <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
|
3510 <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
|
3511 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
|
3512 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
|
3513 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3514 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3515 "key1" : "value1", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3516 "key2" : "value2", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3517 "key3" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3518 "value" : "value3", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3519 "expire" : 30000 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3520 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3521 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
3522 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3523 <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
|
3524 <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
|
3525 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3526 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3527 <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
|
3528 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3529 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3530 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
|
3531 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3532 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3533 <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
|
3534 </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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3536 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
|
3537 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3538 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3539 <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
|
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 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
|
3542 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3543 <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
|
3544 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3545 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3546 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
|
3547 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3548 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3549 <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
|
3550 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3551 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3552 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
|
3553 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3554 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3555 <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
|
3556 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3557 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3558 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
|
3559 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3560 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3561 <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
|
3562 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3563 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3564 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
|
3565 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3566 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3567 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3568 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3569 <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
|
3570 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3571 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3572 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
|
3573 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3574 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3575 <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
|
3576 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3577 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3578 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
|
3579 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3580 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3581 <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
|
3582 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3583 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3584 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
|
3585 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3586 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3587 <literal>ssl</literal></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 <list type="tag"> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3590 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3591 <literal>handshakes</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3592 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3593 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3594 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
|
3595 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3596 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3597 <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
|
3598 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3599 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3600 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
|
3601 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3602 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3603 <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
|
3604 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3605 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3606 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
|
3607 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3608 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3609 <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
|
3610 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3611 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3612 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
|
3613 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3614 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3615 <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
|
3616 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3617 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3618 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
|
3619 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3620 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3621 <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
|
3622 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3623 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3624 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
|
3625 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3626 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3627 <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
|
3628 </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 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
|
3631 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3632 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3633 <literal>verify_failures</literal></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 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
|
3636 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3637 <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
|
3638 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3639 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3640 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
|
3641 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3642 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3643 <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
|
3644 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3645 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3646 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
|
3647 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3648 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3649 <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
|
3650 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3651 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3652 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
|
3653 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3654 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3655 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3656 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3657 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3658 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3659 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3660 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3661 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3662 </list> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3663 </tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3664 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3665 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3666 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3667 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3668 "dns" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3669 "processing" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3670 "connections" : 155569, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3671 "sessions" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3672 "2xx" : 155564, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3673 "4xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3674 "5xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3675 "total" : 155569 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3676 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3677 "discarded" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3678 "received" : 4200363, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3679 "sent" : 20489184, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3680 "ssl" : { |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3681 "handshakes" : 76455, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3682 "handshakes_failed" : 432, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3683 "session_reuses" : 28770, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3684 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3685 "no_common_cipher" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3686 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3687 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3688 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3689 "no_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3690 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3691 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3692 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3693 } |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3694 } |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3695 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3696 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3697 </listitem> |
2469
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3698 <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
|
3699 <para>Stream Connections Limiting:</para> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3700 <list type="tag"> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3701 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3702 <literal>passed</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3703 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3704 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3705 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
|
3706 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3707 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3708 <literal>rejected</literal> (<literal>integer</literal>) |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3709 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3710 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3711 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
|
3712 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3713 <tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3714 <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
|
3715 </tag-name> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3716 <tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3717 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
|
3718 </tag-desc> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3719 </list> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3720 <para>Example:</para> |
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 { |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3723 "passed" : 15, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3724 "rejected" : 0, |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3725 "rejected_dry_run" : 2 |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3726 }</example> |
98fd810c13e0
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2439
diff
changeset
|
3727 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3728 <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
|
3729 <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
|
3730 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3731 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3732 <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
|
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 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
|
3735 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3736 <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
|
3737 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3738 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3739 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
|
3740 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3741 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3742 <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
|
3743 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3744 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3745 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
|
3746 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3747 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3748 <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
|
3749 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3750 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3751 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
|
3752 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3753 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3754 <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
|
3755 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3756 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3757 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
|
3758 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3759 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3760 <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
|
3761 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3762 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3763 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
|
3764 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3765 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3766 <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
|
3767 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3768 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3769 <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
|
3770 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3771 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3772 <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
|
3773 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3774 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3775 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
|
3776 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3777 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3778 <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
|
3779 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3780 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3781 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
|
3782 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3783 <tag-name> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3784 <literal>ssl</literal></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 <list type="tag"> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3787 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3788 <literal>handshakes</literal> (<literal>integer</literal>) |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3789 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3790 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3791 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
|
3792 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3793 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3794 <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
|
3795 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3796 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3797 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
|
3798 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3799 <tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3800 <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
|
3801 </tag-name> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3802 <tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3803 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
|
3804 </tag-desc> |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3805 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3806 <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
|
3807 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3808 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3809 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
|
3810 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3811 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3812 <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
|
3813 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3814 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3815 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
|
3816 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3817 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3818 <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
|
3819 </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 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
|
3822 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3823 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3824 <literal>verify_failures</literal></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 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
|
3827 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3828 <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
|
3829 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3830 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3831 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
|
3832 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3833 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3834 <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
|
3835 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3836 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3837 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
|
3838 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3839 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3840 <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
|
3841 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3842 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3843 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
|
3844 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3845 <tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3846 <literal>other</literal> (<literal>integer</literal>) |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3847 </tag-name> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3848 <tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3849 Other SSL certificate verification errors. |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3850 </tag-desc> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3851 </list> |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3852 </tag-desc> |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3853 </list> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3854 </tag-desc> |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3855 <tag-name> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3856 <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
|
3857 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3858 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3859 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
|
3860 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3861 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3862 <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
|
3863 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3864 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3865 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
|
3866 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3867 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3868 <literal>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
|
3869 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3870 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3871 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
|
3872 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3873 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3874 <literal>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
|
3875 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3876 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3877 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
|
3878 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3879 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3880 <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
|
3881 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3882 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3883 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
|
3884 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3885 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3886 <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
|
3887 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3888 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3889 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
|
3890 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3891 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3892 <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
|
3893 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3894 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3895 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
|
3896 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3897 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3898 <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
|
3899 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3900 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3901 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
|
3902 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3903 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3904 <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
|
3905 </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> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3907 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
|
3908 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3909 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3910 <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
|
3911 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3912 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3913 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3914 <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
|
3915 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3916 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3917 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
|
3918 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3919 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3920 <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
|
3921 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3922 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3923 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
|
3924 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3925 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3926 <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
|
3927 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3928 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3929 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
|
3930 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3931 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3932 <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
|
3933 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3934 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3935 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
|
3936 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3937 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3938 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3939 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3940 <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
|
3941 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3942 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3943 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
|
3944 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3945 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3946 <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
|
3947 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3948 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3949 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
|
3950 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3951 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3952 <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
|
3953 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3954 <tag-desc> |
2253
a89093ff86a3
Clarified ISO 8601 time, changed example, bumped version in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2221
diff
changeset
|
3955 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
|
3956 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3957 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3958 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3959 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3960 <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
|
3961 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3962 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3963 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
|
3964 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3965 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3966 <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
|
3967 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3968 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
3969 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
|
3970 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3971 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3972 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3973 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3974 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3975 "dns" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3976 "peers" : [ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3977 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3978 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3979 "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
|
3980 "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
|
3981 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3982 "weight" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3983 "state" : "up", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3984 "active" : 0, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3985 "ssl" : { |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3986 "handshakes" : 200, |
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3987 "handshakes_failed" : 4, |
2914
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3988 "session_reuses" : 189, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3989 "no_common_protocol" : 4, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3990 "handshake_timeout" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3991 "peer_rejected_cert" : 0, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3992 "verify_failures" : { |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3993 "expired_cert" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3994 "revoked_cert" : 1, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3995 "hostname_mismatch" : 2, |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3996 "other" : 1 |
3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2866
diff
changeset
|
3997 } |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
3998 }, |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
3999 "max_conns" : 50, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4000 "connections" : 667231, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4001 "sent" : 251946292, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4002 "received" : 19222475454, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4003 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4004 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4005 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4006 "checks" : 26214, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4007 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4008 "unhealthy" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4009 "last_passed" : true |
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 "downtime" : 0, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
4012 "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
|
4013 "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
|
4014 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4015 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4016 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4017 "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
|
4018 "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
|
4019 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4020 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4021 "state" : "unhealthy", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4022 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4023 "max_conns" : 50, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4024 "connections" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4025 "sent" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4026 "received" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4027 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4028 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4029 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4030 "checks" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4031 "fails" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4032 "unhealthy" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4033 "last_passed" : false |
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 "downtime" : 262925617, |
2866
8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2768
diff
changeset
|
4036 "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
|
4037 "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
|
4038 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4039 ], |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4040 "zombies" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4041 "zone" : "dns" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4042 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4043 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4044 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4045 <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
|
4046 <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
|
4047 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
|
4048 <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
|
4049 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4050 <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
|
4051 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4052 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4053 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
|
4054 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4055 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4056 <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
|
4057 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4058 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4059 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
|
4060 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4061 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4062 <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
|
4063 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4064 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4065 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
|
4066 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4067 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4068 <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
|
4069 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4070 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4071 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
|
4072 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4073 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4074 <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
|
4075 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4076 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4077 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
|
4078 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4079 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4080 <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
|
4081 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4082 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4083 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
|
4084 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4085 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
4086 <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
|
4087 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4088 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4089 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
|
4090 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4091 <tag-name> |
2133
bb3d2ce5192e
Changed type of fail_timeout and slow_start in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2132
diff
changeset
|
4092 <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
|
4093 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4094 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4095 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
|
4096 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4097 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4098 <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
|
4099 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4100 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4101 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
|
4102 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4103 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4104 <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
|
4105 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4106 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4107 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
|
4108 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4109 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4110 <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
|
4111 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4112 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4113 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
|
4114 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4115 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4116 <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
|
4117 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4118 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4119 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
|
4120 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4121 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4122 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4123 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4124 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4125 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4126 "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
|
4127 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4128 "max_conns" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4129 "max_fails" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4130 "fail_timeout" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4131 "slow_start" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4132 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4133 "down" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4134 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4135 </listitem> |
2082
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4136 <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
|
4137 <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
|
4138 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
|
4139 <example> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4140 { |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4141 "key1" : "value1", |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4142 "key2" : "value2", |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4143 "key3" : "value3" |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4144 }</example> |
fee7627f6a5a
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2072
diff
changeset
|
4145 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4146 <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
|
4147 <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
|
4148 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
|
4149 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
|
4150 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4151 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4152 "key1" : "value1", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4153 "key2" : "value2", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4154 "key3" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4155 "value" : "value3", |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4156 "expire" : 30000 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4157 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4158 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4159 </listitem> |
2139
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4160 <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
|
4161 <para>Stream Zone Sync Node:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4162 <list type="tag"> |
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>zones</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 <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
|
4167 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4168 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4169 <literal>status</literal></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 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
|
4172 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4173 <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
|
4174 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4175 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4176 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
|
4177 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4178 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4179 <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
|
4180 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4181 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4182 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
|
4183 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4184 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4185 <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
|
4186 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4187 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4188 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
|
4189 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4190 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4191 <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
|
4192 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4193 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4194 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
|
4195 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4196 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4197 <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
|
4198 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4199 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4200 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
|
4201 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4202 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4203 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4204 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4205 <para>Example:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4206 <example> |
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 "zones" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4209 "zone1" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4210 "records_pending" : 2061, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4211 "records_total" : 260575 |
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 "zone2" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4214 "records_pending" : 0, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4215 "records_total" : 14749 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4216 } |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4217 }, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4218 "status" : { |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4219 "bytes_in" : 1364923761, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4220 "msgs_in" : 337236, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4221 "msgs_out" : 346717, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4222 "bytes_out" : 1402765472, |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4223 "nodes_online" : 15 |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4224 } |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4225 }</example> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4226 </listitem> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4227 <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
|
4228 <para>Sync Zone:</para> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4229 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
|
4230 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4231 <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
|
4232 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4233 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4234 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
|
4235 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4236 <tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4237 <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
|
4238 </tag-name> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4239 <tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4240 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
|
4241 </tag-desc> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4242 </list> |
f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2133
diff
changeset
|
4243 </listitem> |
2424
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4244 <listitem id="def_nginx_resolver_zone"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4245 <para>Resolver Zone:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4246 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
|
4247 <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
|
4248 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4249 <literal>requests</literal></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 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4252 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4253 <literal>name</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4254 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4255 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4256 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
|
4257 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4258 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4259 <literal>srv</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4260 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4261 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4262 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
|
4263 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4264 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4265 <literal>addr</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4266 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4267 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4268 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
|
4269 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4270 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4271 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4272 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4273 <literal>responses</literal></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 <list type="tag"> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4276 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4277 <literal>noerror</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4278 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4279 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4280 The total number of successful responses. |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4281 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4282 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4283 <literal>formerr</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4284 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4285 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4286 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
|
4287 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4288 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4289 <literal>servfail</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4290 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4291 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4292 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
|
4293 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4294 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4295 <literal>nxdomain</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4296 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4297 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4298 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
|
4299 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4300 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4301 <literal>notimp</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4302 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4303 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4304 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
|
4305 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4306 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4307 <literal>refused</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4308 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4309 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4310 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
|
4311 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4312 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4313 <literal>timedout</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4314 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4315 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4316 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
|
4317 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4318 <tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4319 <literal>unknown</literal> (<literal>integer</literal>) |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4320 </tag-name> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4321 <tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4322 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
|
4323 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4324 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4325 </tag-desc> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4326 </list> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4327 <para>Example:</para> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4328 <example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4329 { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4330 "resolver_zone1" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4331 "requests" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4332 "name" : 25460, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4333 "srv" : 130, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4334 "addr" : 2580 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4335 }, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4336 "responses" : { |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4337 "noerror" : 26499, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4338 "formerr" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4339 "servfail" : 3, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4340 "nxdomain" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4341 "notimp" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4342 "refused" : 0, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4343 "timedout" : 243, |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4344 "unknown" : 478 |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4345 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4346 } |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4347 }</example> |
dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents:
2359
diff
changeset
|
4348 </listitem> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4349 <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
|
4350 <para>Error:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4351 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
|
4352 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4353 <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
|
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 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4356 <tag-name> |
2132
a645aa9f2ebf
Changed type of HTTP error code to integer in API.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2082
diff
changeset
|
4357 <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
|
4358 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4359 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4360 HTTP error code. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4361 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4362 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4363 <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
|
4364 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4365 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4366 Error description. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4367 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4368 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4369 <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
|
4370 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4371 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4372 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
|
4373 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4374 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4375 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4376 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4377 <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
|
4378 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4379 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
4380 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
|
4381 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4382 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4383 <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
|
4384 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4385 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4386 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
|
4387 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4388 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4389 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4390 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4391 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4392 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4393 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
4394 </module> |