Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_api_module.xml @ 2076:07239ff77f50
Updated supported functionality for nginScript.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Wed, 22 Nov 2017 21:30:27 +0300 |
parents | 116994597b0e |
children | fee7627f6a5a |
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" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
12 rev="1"> |
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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
34 <note> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
35 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
|
36 <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
|
37 </note> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
38 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
39 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
40 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
41 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
42 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
43 <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
|
44 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
45 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
46 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
47 http { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
48 upstream backend { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
49 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
|
50 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
51 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
|
52 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
|
53 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
54 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
55 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
|
56 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
57 server { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
58 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
|
59 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
60 location / { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
61 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
|
62 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
|
63 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
64 health_check; |
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 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
67 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
|
68 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
69 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
70 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
|
71 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
|
72 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
73 server { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
74 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
|
75 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
76 location /api { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
77 <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
|
78 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
|
79 deny all; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
80 } |
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 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
83 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
84 stream { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
85 upstream backend { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
86 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
|
87 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
88 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
|
89 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
|
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 server { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
93 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
|
94 proxy_pass backend; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
95 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
|
96 health_check; |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
97 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
98 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
99 </example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
100 All API requests include 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
|
101 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
|
102 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
103 http://127.0.0.1/api/1/ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
104 http://127.0.0.1/api/1/nginx |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
105 http://127.0.0.1/api/1/connections |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
106 http://127.0.0.1/api/1/http/requests |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
107 http://127.0.0.1/api/1/http/server_zones/server_backend |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
108 http://127.0.0.1/api/1/http/caches/cache_backend |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
109 http://127.0.0.1/api/1/http/upstreams/backend |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
110 http://127.0.0.1/api/1/http/upstreams/backend/servers/ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
111 http://127.0.0.1/api/1/http/upstreams/backend/servers/1 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
112 http://127.0.0.1/api/1/http/keyvals/one?key=arg1 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
113 http://127.0.0.1/api/1/stream/ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
114 http://127.0.0.1/api/1/stream/server_zones/server_backend |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
115 http://127.0.0.1/api/1/stream/upstreams/ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
116 http://127.0.0.1/api/1/stream/upstreams/backend |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
117 http://127.0.0.1/api/1/stream/upstreams/backend/servers/1 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
118 </example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
119 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
120 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
121 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
122 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
123 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
124 <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
|
125 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
126 <directive name="api"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
127 <syntax> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
128 [<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
|
129 <default/> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
130 <context>location</context> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
131 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
132 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
133 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
|
134 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
|
135 <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
|
136 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
137 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
138 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
139 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
|
140 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
|
141 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
|
142 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
143 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
144 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
145 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
|
146 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
|
147 the list of supported API versions is returned. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
148 The current and the only API version is “<literal>1</literal>”. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
149 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
150 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
151 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
152 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
|
153 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
|
154 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
155 http://127.0.0.1/api/1/nginx?fields=version,build |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
156 </example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
157 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
158 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
159 </directive> |
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 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
162 <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
|
163 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
164 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
165 <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
|
166 <literal>/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
167 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
168 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
169 <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
|
170 <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
|
171 <listitem id="getAPIEndpoints"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
172 <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
|
173 <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
|
174 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
175 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
176 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
177 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
178 <listitem>200 - Success, returns an array of strings</listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
179 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
180 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
181 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
182 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
183 <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
|
184 <literal>/nginx</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
185 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
186 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
187 <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
|
188 <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
|
189 <listitem id="getNginx"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
190 <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
|
191 <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
|
192 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
193 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
194 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
195 <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
|
196 (<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
|
197 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
198 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
|
199 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
200 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
201 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
202 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
203 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
204 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
205 <listitem>200 - Success, returns <link id="def_nginx_object">nginx</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
206 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
207 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
208 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
209 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
210 <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
|
211 <literal>/processes</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
212 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
213 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
214 <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
|
215 <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
|
216 <listitem id="getProcesses"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
217 <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
|
218 <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
|
219 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
220 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
221 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
222 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
223 <listitem>200 - Success, returns <link id="def_nginx_processes">Processes</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
224 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
225 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
226 <listitem id="deleteProcesses"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
227 <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
|
228 <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
|
229 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
230 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
231 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
232 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
233 <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
|
234 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
235 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
236 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
237 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
238 <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
|
239 <literal>/connections</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
240 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
241 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
242 <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
|
243 <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
|
244 <listitem id="getConnections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
245 <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
|
246 <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
|
247 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
248 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
249 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
250 <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
|
251 (<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
|
252 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
253 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
|
254 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
255 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
256 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
257 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
258 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
259 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
260 <listitem>200 - Success, returns <link id="def_nginx_connections">Connections</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
261 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
262 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
263 <listitem id="deleteConnections"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
264 <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
|
265 <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
|
266 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
267 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
268 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
269 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
270 <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
|
271 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
272 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
273 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
274 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
275 <tag-name id="ssl" name="/ssl"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
276 <literal>/ssl</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
277 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
278 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
279 <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
|
280 <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
|
281 <listitem id="getSsl"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
282 <literal>GET</literal> - Return SSL statistics |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
283 <para>Returns SSL statistics.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
284 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
285 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
286 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
287 <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
|
288 (<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
|
289 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
290 Limits which fields of SSL 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
|
291 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
292 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
293 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
294 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
295 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
296 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
297 <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
298 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
299 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
300 <listitem id="deleteSslStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
301 <literal>DELETE</literal> - Reset SSL statistics |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
302 <para>Resets counters of SSL handshakes and session reuses.</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
303 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
304 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
305 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
306 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
307 <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
|
308 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
309 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
310 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
311 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
312 <tag-name id="slabs_" name="/slabs/"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
313 <literal>/slabs/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
314 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
315 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
316 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
317 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
318 <listitem id="getSlabs"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
319 <literal>GET</literal> - Return status of all slabs |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
320 <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
|
321 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
322 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
323 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
324 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
325 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
326 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
327 Limits which fields of slab zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names are 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
|
328 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
329 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
330 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
331 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
332 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
333 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
334 <listitem>200 - Success, returns a collection of "<link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link>" objects for all slabs </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
335 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
336 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
337 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
338 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
339 <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
|
340 <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
|
341 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
342 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
343 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
|
344 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
345 <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
|
346 (<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
|
347 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
348 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
|
349 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
350 <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
|
351 <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
|
352 <listitem id="getSlabZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
353 <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
|
354 <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
|
355 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
356 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
357 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
358 <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
|
359 (<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
|
360 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
361 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
|
362 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
363 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
364 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
365 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
366 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
367 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
368 <listitem>200 - Success, returns <link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
369 <listitem>404 - Slab not found (<literal>SlabNotFound</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
|
370 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
371 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
372 <listitem id="deleteSlabZoneStats"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
373 <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
|
374 <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
|
375 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
376 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
377 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
378 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
379 <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
|
380 <listitem>404 - Slab not found (<literal>SlabNotFound</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
|
381 <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
|
382 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
383 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
384 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
385 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
386 <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
|
387 <literal>/http/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
388 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
389 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
390 <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
|
391 <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
|
392 <listitem id="getHttp"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
393 <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
|
394 <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
|
395 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
396 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
397 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
398 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
399 <listitem>200 - Success, returns an array of strings</listitem> |
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 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
403 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
404 <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
|
405 <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
|
406 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
407 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
408 <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
|
409 <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
|
410 <listitem id="getHttpRequests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
411 <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
|
412 <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
|
413 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
414 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
415 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
416 <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
|
417 (<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
|
418 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
419 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
|
420 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
421 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
422 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
423 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
424 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
425 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
426 <listitem>200 - Success, returns <link id="def_nginx_http_requests">HTTP Requests</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
427 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
428 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
429 <listitem id="deleteHttpRequests"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
430 <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
|
431 <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
|
432 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
433 Possible responses: |
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 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
436 <listitem>204 - Success</listitem> |
2047
593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2046
diff
changeset
|
437 <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
|
438 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
439 </listitem> |
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 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
442 <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
|
443 <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
|
444 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
445 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
446 <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
|
447 <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
|
448 <listitem id="getHttpServerZones"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
449 <literal>GET</literal> - Return status of all HTTP server zones |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
450 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_status_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
|
451 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
452 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
453 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
454 <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
|
455 (<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
|
456 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
457 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names are 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
|
458 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
459 </para> |
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 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
462 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
463 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
464 <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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
465 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
466 </listitem> |
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 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
469 <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
|
470 <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
|
471 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
472 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
473 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
|
474 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
475 <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
|
476 (<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
|
477 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
478 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
|
479 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
480 <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
|
481 <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
|
482 <listitem id="getHttpServerZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
483 <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
|
484 <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
|
485 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
486 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
487 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
488 <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
|
489 (<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
|
490 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
491 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
|
492 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
493 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
494 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
495 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
496 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
497 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
498 <listitem>200 - Success, returns <link id="def_nginx_http_server_zone">HTTP Server Zone</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
499 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</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
|
500 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
501 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
502 <listitem id="deleteHttpServerZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
503 <literal>DELETE</literal> - Reset statistics for an HTTP server zone |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
504 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular HTTP server zone.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
505 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
506 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
507 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
508 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
509 <listitem>204 - Success</listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
510 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</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
|
511 <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
|
512 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
513 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
514 </list> |
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 <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
|
517 <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
|
518 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
519 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
520 <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
|
521 <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
|
522 <listitem id="getHttpCaches"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
523 <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
|
524 <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
|
525 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
526 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
527 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
528 <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
|
529 (<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
|
530 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
531 Limits which fields of cache zones will be output. If the “<literal>fields</literal>” value is empty, then only names of cache zones are 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
|
532 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
533 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
534 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
535 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
536 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
537 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
538 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_cache">HTTP Cache</link>" objects for all http caches </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
539 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
540 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
541 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
542 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
543 <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
|
544 <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
|
545 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
546 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
547 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
|
548 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
549 <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
|
550 (<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
|
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 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
|
553 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
554 <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
|
555 <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
|
556 <listitem id="getHttpCacheZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
557 <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
|
558 <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
|
559 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
560 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
561 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
562 <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
|
563 (<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
|
564 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
565 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
|
566 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
567 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
568 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
569 Possible responses: |
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 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
572 <listitem>200 - Success, returns <link id="def_nginx_http_cache">HTTP Cache</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
573 <listitem>404 - Cache not found (<literal>CacheNotFound</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
|
574 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
575 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
576 <listitem id="deleteHttpCacheZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
577 <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
|
578 <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
|
579 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
580 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
581 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
582 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
583 <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
|
584 <listitem>404 - Cache not found (<literal>CacheNotFound</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
|
585 <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
|
586 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
587 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
588 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
589 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
590 <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
|
591 <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
|
592 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
593 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
594 <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
|
595 <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
|
596 <listitem id="getHttpUpstreams"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
597 <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
|
598 <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
|
599 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
600 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
601 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
602 <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
|
603 (<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
|
604 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
605 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams are 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
|
606 </list> |
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 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
609 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
610 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
611 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
612 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_upstream">HTTP Upstream</link>" objects for all http upstreams </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
613 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
614 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
615 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
616 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
617 <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
|
618 <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
|
619 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
620 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
621 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
|
622 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
623 <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
|
624 (<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
|
625 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
626 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
|
627 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
628 <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
|
629 <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
|
630 <listitem id="getHttpUpstreamName"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
631 <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
|
632 <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
|
633 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
634 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
635 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
636 <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
|
637 (<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
|
638 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
639 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
|
640 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
641 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
642 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
643 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
644 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
645 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
646 <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
|
647 <listitem>400 - Upstream is static (<literal>UpstreamStatic</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
|
648 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</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
|
649 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
650 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
651 <listitem id="deleteHttpUpstreamStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
652 <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
|
653 <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
|
654 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
655 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
656 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
657 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
658 <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
|
659 <listitem>400 - Upstream is static (<literal>UpstreamStatic</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
|
660 <listitem>404 - 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
|
661 <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
|
662 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
663 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
664 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
665 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
666 <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
|
667 <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
|
668 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
669 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
670 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
|
671 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
672 <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
|
673 (<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
|
674 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
675 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
|
676 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
677 <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
|
678 <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
|
679 <listitem id="getHttpUpstreamServers"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
680 <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
|
681 <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
|
682 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
683 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
684 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
685 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
686 <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
|
687 <listitem>400 - Upstream is static (<literal>UpstreamStatic</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
|
688 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</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
|
689 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
690 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
691 <listitem id="postHttpUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
692 <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
|
693 <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
|
694 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
695 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
696 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
697 <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
|
698 (<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
|
699 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
700 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
|
701 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
702 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
703 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
704 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
705 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
706 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
707 <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
|
708 <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
|
709 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
|
710 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
|
711 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
|
712 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
|
713 “<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
|
714 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
|
715 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
|
716 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
|
717 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
|
718 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
|
719 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
|
720 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
|
721 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
|
722 “<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
|
723 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
|
724 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
|
725 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</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
|
726 <listitem>404 - 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
|
727 <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
|
728 <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
|
729 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
730 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
731 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
732 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
733 <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
|
734 <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
|
735 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
736 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
737 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
|
738 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
739 <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
|
740 (<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
|
741 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
742 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
|
743 <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
|
744 (<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
|
745 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
746 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
|
747 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
748 <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
|
749 <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
|
750 <listitem id="getHttpUpstreamPeer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
751 <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
|
752 <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
|
753 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
754 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
755 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
756 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
757 <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
|
758 <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
|
759 invalid server ID (<literal>UpstreamBadServerId</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
|
760 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
761 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</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
|
762 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
763 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
764 <listitem id="patchHttpUpstreamPeer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
765 <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
|
766 <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
|
767 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
768 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
769 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
770 <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
|
771 (<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
|
772 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
773 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
|
774 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
775 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
776 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
777 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
778 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
779 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
780 <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
|
781 <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
|
782 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
|
783 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
|
784 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
|
785 “<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
|
786 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
|
787 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
|
788 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
|
789 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
|
790 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
|
791 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
|
792 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
|
793 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
|
794 “<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
|
795 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
|
796 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
|
797 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</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
|
798 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
799 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</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
|
800 <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
|
801 <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
|
802 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
803 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
804 <listitem id="deleteHttpUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
805 <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
|
806 <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
|
807 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
808 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
809 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
810 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
811 <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
|
812 <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
|
813 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
|
814 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</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
|
815 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
816 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</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
|
817 <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
|
818 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
819 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
820 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
821 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
822 <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
|
823 <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
|
824 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
825 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
826 <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
|
827 <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
|
828 <listitem id="getHttpKeyvalZones"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
829 <literal>GET</literal> - Return key-value pairs from all keyval zones |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
830 <para>Returns key-value pairs for each 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
|
831 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
832 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
833 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
834 <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
|
835 (<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
|
836 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
837 If the “<literal>fields</literal>” value is empty, then only keyval zone names are 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
|
838 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
839 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
840 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
841 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
842 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
843 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
844 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</link>" objects for all http keyvals </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
845 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
846 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
847 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
848 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
849 <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
|
850 <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
|
851 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
852 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
853 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
|
854 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
855 <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
|
856 (<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
|
857 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
858 The name of a keyval shared memory zone.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
859 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
860 <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
|
861 <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
|
862 <listitem id="getHttpKeyvalZoneKeysValues"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
863 <literal>GET</literal> - Return key-value pairs from a keyval zone |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
864 <para>Returns key-value pairs stored in a particular 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
|
865 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
866 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
867 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
868 <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
|
869 (<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
|
870 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
871 Get a particular key-value pair from the keyval zone.</tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
872 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
873 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
874 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
875 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
876 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
877 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
878 <listitem>200 - Success, returns <link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
879 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
880 keyval key not found (<literal>KeyvalKeyNotFound</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
|
881 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
882 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
883 <listitem id="postHttpKeyvalZoneData"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
884 <literal>POST</literal> - Add a key-value pair to the keyval zone |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
885 <para>Adds a new key-value pair to the 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 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
|
886 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
887 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
888 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
889 <tag-name><literal>Key-value</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
890 (<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</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
|
891 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
892 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the keyval shared memory zone is empty.</tag-desc> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
893 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
894 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
895 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
896 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
897 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
898 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
899 <listitem>201 - Created</listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
900 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
901 only one key can be added (<literal>KeyvalFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
902 nested object or list (<literal>KeyvalFormatError</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
|
903 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</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
|
904 <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
|
905 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</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
|
906 <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
|
907 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
908 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
909 <listitem id="patchHttpKeyvalZoneKeyValue"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
910 <literal>PATCH</literal> - Modify a key-value or delete a key |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
911 <para>Changes the value of the selected key in the key-value pair or deletes a key by setting the key value to <literal>null</literal>.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
912 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
913 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
914 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
915 <tag-name><literal>httpKeyvalZoneKeyValue</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
916 (<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</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
|
917 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
918 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
|
919 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
920 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
921 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
922 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
923 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
924 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
925 <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
|
926 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
927 only one key can be updated (<literal>KeyvalFormatError</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
928 nested object or list (<literal>KeyvalFormatError</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
|
929 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
930 keyval key not found (<literal>KeyvalKeyNotFound</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
|
931 <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
|
932 <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
|
933 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
934 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
935 <listitem id="deleteHttpKeyvalZoneData"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
936 <literal>DELETE</literal> - Empty the keyval zone |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
937 <para>Deletes all key-value pairs from the 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
|
938 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
939 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
940 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
941 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
942 <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
|
943 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</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
|
944 <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
|
945 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
946 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
947 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
948 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
949 <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
|
950 <literal>/stream/</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
951 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
952 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
953 <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
|
954 <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
|
955 <listitem id="getStream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
956 <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
|
957 <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
|
958 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
959 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
960 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
961 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
962 <listitem>200 - Success, returns an array of strings</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 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
965 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
966 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
967 <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
|
968 <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
|
969 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
970 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
971 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
972 <list type="bullet" compact="yes"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
973 <listitem id="getStreamServerZones"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
974 <literal>GET</literal> - Return status of all stream server zones |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
975 <para>Returns status information for each stream <link url="https://nginx.org/en/docs/http/ngx_http_status_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
|
976 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
977 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
978 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
979 <tag-name><literal>fields</literal> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
980 (<literal>string</literal>, optional)</tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
981 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
982 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names are 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
|
983 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
984 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
985 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
986 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
987 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
988 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
989 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_server_zone">Stream Server Zone</link>" objects for all stream server zones </listitem> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
990 <listitem>404 - <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
991 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
992 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
993 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
994 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
995 <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
|
996 <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
|
997 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
998 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
999 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
|
1000 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1001 <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
|
1002 (<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
|
1003 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1004 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
|
1005 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1006 <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
|
1007 <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
|
1008 <listitem id="getStreamServerZone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1009 <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
|
1010 <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
|
1011 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1012 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1013 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1014 <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
|
1015 (<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
|
1016 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1017 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
|
1018 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1019 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1020 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1021 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1022 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1023 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1024 <listitem>200 - Success, returns <link id="def_nginx_stream_server_zone">Stream Server Zone</link></listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1025 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1026 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1027 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1028 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1029 <listitem id="deleteStreamServerZoneStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1030 <literal>DELETE</literal> - Reset statistics for a stream server zone |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1031 <para>Resets statistics of accepted and discarded connections, sessions, received and sent bytes in a particular stream server zone.</para> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
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>204 - Success</listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1037 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1038 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1039 <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
|
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 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1043 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1044 <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
|
1045 <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
|
1046 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1047 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1048 <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
|
1049 <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
|
1050 <listitem id="getStreamUpstreams"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1051 <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
|
1052 <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
|
1053 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1054 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1055 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1056 <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
|
1057 (<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
|
1058 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1059 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams are 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
|
1060 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1061 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1062 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1063 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1064 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1065 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1066 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams </listitem> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1067 <listitem>404 - <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1068 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1069 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1070 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1071 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1072 <tag-name 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
|
1073 <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
|
1074 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1075 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1076 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
|
1077 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1078 <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
|
1079 (<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
|
1080 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1081 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
|
1082 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1083 <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
|
1084 <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
|
1085 <listitem id="getStreamUpstream"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1086 <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
|
1087 <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
|
1088 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1089 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1090 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1091 <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
|
1092 (<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
|
1093 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1094 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
|
1095 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1096 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1097 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1098 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1099 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1100 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1101 <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
|
1102 <listitem>400 - Upstream is static (<literal>UpstreamStatic</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
|
1103 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1104 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1105 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1106 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1107 <listitem id="deleteStreamUpstreamStat"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1108 <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
|
1109 <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
|
1110 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1111 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1112 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1113 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1114 <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
|
1115 <listitem>400 - Upstream is static (<literal>UpstreamStatic</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
|
1116 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1117 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1118 <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
|
1119 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1120 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1121 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1122 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1123 <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
|
1124 <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
|
1125 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1126 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1127 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
|
1128 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1129 <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
|
1130 (<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
|
1131 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1132 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
|
1133 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1134 <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
|
1135 <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
|
1136 <listitem id="getStreamUpstreamServers"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1137 <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
|
1138 <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
|
1139 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1140 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1141 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1142 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1143 <listitem>200 - Success, returns an array of <link id="def_nginx_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
|
1144 <listitem>400 - Upstream is static (<literal>UpstreamStatic</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
|
1145 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1146 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1147 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1148 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1149 <listitem id="postStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1150 <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
|
1151 <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
|
1152 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1153 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1154 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1155 <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
|
1156 (<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
|
1157 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1158 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
|
1159 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1160 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1161 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1162 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1163 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1164 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1165 <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
|
1166 <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
|
1167 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
|
1168 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
|
1169 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
|
1170 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
|
1171 “<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
|
1172 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
|
1173 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
|
1174 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
|
1175 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
|
1176 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
|
1177 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
|
1178 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
|
1179 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
|
1180 “<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
|
1181 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
|
1182 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
|
1183 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</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
|
1184 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1185 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1186 <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
|
1187 <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
|
1188 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1189 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1190 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1191 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1192 <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
|
1193 <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
|
1194 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1195 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1196 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
|
1197 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1198 <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
|
1199 (<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
|
1200 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1201 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
|
1202 <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
|
1203 (<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
|
1204 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1205 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
|
1206 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1207 <para>Supported methods:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1208 <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
|
1209 <listitem id="getStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1210 <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
|
1211 <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
|
1212 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1213 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1214 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1215 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1216 <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
|
1217 <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
|
1218 invalid server ID (<literal>UpstreamBadServerId</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
|
1219 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1220 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1221 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1222 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1223 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1224 <listitem id="patchStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1225 <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
|
1226 <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
|
1227 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1228 Request parameters: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1229 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1230 <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
|
1231 (<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
|
1232 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1233 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
|
1234 </list> |
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 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1237 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1238 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1239 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1240 <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
|
1241 <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
|
1242 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
|
1243 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
|
1244 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
|
1245 “<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
|
1246 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
|
1247 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
|
1248 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
|
1249 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
|
1250 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
|
1251 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
|
1252 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
|
1253 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
|
1254 “<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
|
1255 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
|
1256 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
|
1257 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</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
|
1258 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1259 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1260 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1261 <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
|
1262 <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
|
1263 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1264 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1265 <listitem id="deleteStreamUpstreamServer"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1266 <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
|
1267 <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
|
1268 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1269 Possible responses: |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1270 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1271 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1272 <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
|
1273 <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
|
1274 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
|
1275 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</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
|
1276 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1277 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1278 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</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
|
1279 <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
|
1280 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1281 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1282 </list> |
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 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1285 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1286 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1287 <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
|
1288 <para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1289 <list type="bullet"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1290 <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
|
1291 <para>nginx:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1292 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
|
1293 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1294 <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
|
1295 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1296 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1297 Version of nginx. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1298 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1299 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1300 <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
|
1301 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1302 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1303 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
|
1304 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1305 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1306 <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
|
1307 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1308 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1309 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
|
1310 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1311 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1312 <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
|
1313 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1314 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1315 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
|
1316 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1317 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1318 <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
|
1319 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1320 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1321 Time of the last reload of configuration, in milliseconds since Epoch. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1322 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1323 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1324 <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
|
1325 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1326 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1327 Current time in milliseconds since Epoch. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1328 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1329 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1330 <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
|
1331 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1332 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1333 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
|
1334 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1335 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1336 <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
|
1337 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1338 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1339 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
|
1340 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1341 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1342 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1343 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1344 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1345 "nginx" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1346 "version" : "1.13.3", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1347 "build" : "nginx-plus-r12-p3", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1348 "address" : "206.251.255.64", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1349 "generation" : 2, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1350 "load_timestamp" : "2017-07-07T11:09:21.594Z", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1351 "timestamp" : "2017-07-11T09:31:13.477Z", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1352 "pid" : 32212, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1353 "ppid" : 32210 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1354 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1355 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1356 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1357 <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
|
1358 <para>Processes:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1359 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1360 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1361 <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
|
1362 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1363 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1364 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
|
1365 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1366 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1367 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1368 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1369 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1370 "respawned" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1371 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1372 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1373 <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
|
1374 <para>Connections:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1375 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
|
1376 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1377 <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
|
1378 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1379 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1380 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
|
1381 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1382 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1383 <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
|
1384 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1385 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1386 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
|
1387 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1388 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1389 <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
|
1390 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1391 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1392 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
|
1393 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1394 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1395 <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
|
1396 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1397 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1398 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
|
1399 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1400 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1401 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1402 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1403 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1404 "accepted" : 4968119, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1405 "dropped" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1406 "active" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1407 "idle" : 117 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1408 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1409 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1410 <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
|
1411 <para>SSL:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1412 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1413 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1414 <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
|
1415 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1416 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1417 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
|
1418 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1419 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1420 <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
|
1421 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1422 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1423 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
|
1424 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1425 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1426 <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
|
1427 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1428 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1429 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
|
1430 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1431 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1432 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1433 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1434 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1435 "handshakes" : 79572, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1436 "handshakes_failed" : 21025, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1437 "session_reuses" : 15762 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1438 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1439 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1440 <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
|
1441 <para>Shared memory zone with slab allocator:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1442 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1443 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1444 <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
|
1445 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1446 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
|
1447 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1448 <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
|
1449 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1450 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1451 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
|
1452 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1453 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1454 <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
|
1455 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1456 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1457 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
|
1458 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1459 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1460 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1461 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1462 <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
|
1463 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1464 <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
|
1465 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1466 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1467 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1468 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1469 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1470 "pages" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1471 "used" : 1143, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1472 "free" : 2928 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1473 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1474 "slots" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1475 "8" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1476 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1477 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1478 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1479 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1480 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1481 "16" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1482 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1483 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1484 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1485 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1486 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1487 "32" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1488 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1489 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1490 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1491 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1492 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1493 "64" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1494 "used" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1495 "free" : 63, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1496 "reqs" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1497 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1498 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1499 "128" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1500 "used" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1501 "free" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1502 "reqs" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1503 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1504 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1505 "256" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1506 "used" : 18078, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1507 "free" : 178, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1508 "reqs" : 1635736, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1509 "fails" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1510 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1511 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1512 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1513 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1514 <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
|
1515 <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
|
1516 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1517 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1518 <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
|
1519 </tag-name> |
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 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
|
1522 </tag-desc> |
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 <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
|
1525 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1526 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1527 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
|
1528 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1529 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1530 <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
|
1531 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1532 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1533 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
|
1534 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1535 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1536 <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
|
1537 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1538 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1539 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
|
1540 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1541 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1542 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1543 <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
|
1544 <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
|
1545 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1546 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1547 <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
|
1548 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1549 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1550 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
|
1551 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1552 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1553 <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
|
1554 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1555 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1556 The 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
|
1557 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1558 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1559 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1560 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1561 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1562 "total" : 10624511, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1563 "current" : 4 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1564 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1565 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1566 <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
|
1567 <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
|
1568 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1569 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1570 <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
|
1571 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1572 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1573 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
|
1574 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1575 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1576 <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
|
1577 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1578 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1579 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
|
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 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1582 <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
|
1583 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1584 The total number of responses sent to clients and the number of responses with status codes “<literal>1xx</literal>”, “<literal>2xx</literal>”, “<literal>3xx</literal>”, “<literal>4xx</literal>”, and “<literal>5xx</literal>”.<list type="tag"> |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1585 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1586 <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
|
1587 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1588 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1589 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
|
1590 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1591 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1592 <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
|
1593 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1594 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1595 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
|
1596 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1597 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1598 <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
|
1599 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1600 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1601 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
|
1602 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1603 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1604 <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
|
1605 </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> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1607 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
|
1608 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1609 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1610 <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
|
1611 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1612 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1613 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
|
1614 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1615 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1616 <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
|
1617 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1618 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1619 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
|
1620 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1621 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1622 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1623 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1624 <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
|
1625 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1626 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1627 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
|
1628 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1629 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1630 <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
|
1631 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1632 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1633 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
|
1634 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1635 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1636 <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
|
1637 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1638 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1639 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
|
1640 </tag-desc> |
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 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1643 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1644 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1645 "processing" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1646 "requests" : 706690, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1647 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1648 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1649 "2xx" : 699482, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1650 "3xx" : 4522, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1651 "4xx" : 907, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1652 "5xx" : 266, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1653 "total" : 705177 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1654 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1655 "discarded" : 1513, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1656 "received" : 172711587, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1657 "sent" : 19415530115 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1658 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1659 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1660 <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
|
1661 <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
|
1662 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1663 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1664 <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
|
1665 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1666 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1667 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
|
1668 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1669 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1670 <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
|
1671 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1672 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1673 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
|
1674 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1675 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1676 <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
|
1677 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1678 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1679 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
|
1680 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1681 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1682 <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
|
1683 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1684 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1685 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1686 <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
|
1687 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1688 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1689 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
|
1690 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1691 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1692 <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
|
1693 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1694 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1695 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
|
1696 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1697 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1698 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1699 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1700 <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
|
1701 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1702 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1703 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1704 <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
|
1705 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1706 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1707 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
|
1708 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1709 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1710 <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
|
1711 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1712 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1713 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
|
1714 </tag-desc> |
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 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1717 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1718 <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
|
1719 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1720 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1721 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1722 <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
|
1723 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1724 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1725 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
|
1726 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1727 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1728 <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
|
1729 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1730 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1731 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
|
1732 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1733 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1734 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1735 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1736 <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
|
1737 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1738 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1739 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1740 <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
|
1741 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1742 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1743 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
|
1744 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1745 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1746 <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
|
1747 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1748 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1749 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
|
1750 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1751 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1752 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1753 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1754 <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
|
1755 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1756 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1757 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1758 <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
|
1759 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1760 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1761 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
|
1762 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1763 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1764 <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
|
1765 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1766 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1767 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
|
1768 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1769 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1770 <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
|
1771 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1772 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1773 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
|
1774 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1775 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1776 <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
|
1777 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1778 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1779 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
|
1780 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1781 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1782 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1783 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1784 <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
|
1785 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1786 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1787 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1788 <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
|
1789 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1790 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1791 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
|
1792 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1793 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1794 <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
|
1795 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1796 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1797 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
|
1798 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1799 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1800 <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
|
1801 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1802 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1803 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
|
1804 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1805 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1806 <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
|
1807 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1808 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1809 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
|
1810 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1811 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1812 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1813 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1814 <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
|
1815 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1816 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1817 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1818 <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
|
1819 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1820 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1821 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
|
1822 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1823 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1824 <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
|
1825 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1826 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1827 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
|
1828 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1829 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1830 <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
|
1831 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1832 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1833 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
|
1834 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1835 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1836 <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
|
1837 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1838 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1839 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
|
1840 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1841 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1842 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1843 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1844 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1845 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1846 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1847 "size" : 530915328, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1848 "max_size" : 536870912, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1849 "cold" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1850 "hit" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1851 "responses" : 254032, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1852 "bytes" : 6685627875 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1853 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1854 "stale" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1855 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1856 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1857 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1858 "updating" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1859 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1860 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1861 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1862 "revalidated" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1863 "responses" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1864 "bytes" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1865 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1866 "miss" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1867 "responses" : 1619201, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1868 "bytes" : 53841943822 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1869 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1870 "expired" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1871 "responses" : 45859, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1872 "bytes" : 1656847080, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1873 "responses_written" : 44992, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1874 "bytes_written" : 1641825173 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1875 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1876 "bypass" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1877 "responses" : 200187, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1878 "bytes" : 5510647548, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1879 "responses_written" : 200173, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1880 "bytes_written" : 44992 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1881 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1882 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1883 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1884 <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
|
1885 <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
|
1886 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1887 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1888 <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
|
1889 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1890 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
|
1891 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1892 <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
|
1893 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1894 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1895 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
|
1896 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1897 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1898 <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
|
1899 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1900 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1901 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
|
1902 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1903 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1904 <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
|
1905 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1906 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1907 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
|
1908 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1909 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1910 <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
|
1911 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1912 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1913 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
|
1914 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1915 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1916 <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
|
1917 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1918 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1919 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
|
1920 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1921 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1922 <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
|
1923 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1924 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1925 <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
|
1926 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1927 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1928 <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
|
1929 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1930 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1931 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
|
1932 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1933 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1934 <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
|
1935 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1936 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1937 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
|
1938 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1939 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1940 <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
|
1941 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1942 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
1943 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
|
1944 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1945 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1946 <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
|
1947 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1948 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1949 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
|
1950 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1951 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1952 <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
|
1953 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1954 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1955 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1956 <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
|
1957 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1958 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1959 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
|
1960 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1961 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1962 <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
|
1963 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1964 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1965 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
|
1966 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1967 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1968 <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
|
1969 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1970 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1971 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
|
1972 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1973 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1974 <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
|
1975 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1976 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1977 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
|
1978 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1979 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1980 <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
|
1981 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1982 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1983 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
|
1984 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1985 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1986 <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
|
1987 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1988 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1989 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
|
1990 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1991 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1992 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1993 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1994 <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
|
1995 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1996 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1997 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
|
1998 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
1999 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2000 <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
|
2001 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2002 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2003 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
|
2004 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2005 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2006 <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
|
2007 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2008 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2009 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
|
2010 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2011 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2012 <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
|
2013 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2014 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2015 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
|
2016 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2017 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2018 <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
|
2019 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2020 <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>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
|
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> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2025 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
|
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>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
|
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 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
|
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>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
|
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> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2037 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
|
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>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
|
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 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
|
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 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2046 </tag-desc> |
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 <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
|
2049 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2050 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2051 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
|
2052 </tag-desc> |
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 <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
|
2055 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2056 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2057 The time (in milliseconds since Epoch) when the server became “<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
|
2058 </tag-desc> |
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 <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
|
2061 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2062 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2063 The time (in milliseconds since Epoch) when the server was last selected to process a request. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2064 </tag-desc> |
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 <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
|
2067 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2068 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2069 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
|
2070 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2071 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2072 <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
|
2073 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2074 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2075 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
|
2076 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2077 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2078 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2079 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2080 <literal>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
|
2081 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2082 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2083 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
|
2084 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2085 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2086 <literal>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
|
2087 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2088 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2089 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
|
2090 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2091 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2092 <literal>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
|
2093 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2094 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2095 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
|
2096 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2097 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2098 <literal>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
|
2099 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2100 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
|
2101 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2102 <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
|
2103 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2104 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2105 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
|
2106 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2107 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2108 <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
|
2109 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2110 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2111 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
|
2112 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2113 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2114 <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
|
2115 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2116 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2117 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
|
2118 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2119 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2120 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2121 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2122 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2123 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2124 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2125 "upstream_backend" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2126 "peers" : [ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2127 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2128 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2129 "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
|
2130 "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
|
2131 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2132 "weight" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2133 "state" : "up", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2134 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2135 "max_conns" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2136 "requests" : 667231, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2137 "header_time" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2138 "response_time" : 36, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2139 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2140 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2141 "2xx" : 666310, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2142 "3xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2143 "4xx" : 915, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2144 "5xx" : 6, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2145 "total" : 667231 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2146 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2147 "sent" : 251946292, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2148 "received" : 19222475454, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2149 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2150 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2151 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2152 "checks" : 26214, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2153 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2154 "unhealthy" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2155 "last_passed" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2156 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2157 "downtime" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2158 "downstart" : "2017-07-07T11:09:21.602Z", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2159 "selected" : "2017-07-17T15:01:25.000Z" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2160 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2161 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2162 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2163 "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
|
2164 "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
|
2165 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2166 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2167 "state" : "unhealthy", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2168 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2169 "max_conns" : 20, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2170 "requests" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2171 "responses" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2172 "1xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2173 "2xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2174 "3xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2175 "4xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2176 "5xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2177 "total" : 0 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2178 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2179 "sent" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2180 "received" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2181 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2182 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2183 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2184 "checks" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2185 "fails" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2186 "unhealthy" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2187 "last_passed" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2188 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2189 "downtime" : 262925617, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2190 "downstart" : "2017-07-07T11:09:21.602Z", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2191 "selected" : "2017-07-17T15:01:25.000Z" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2192 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2193 ], |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2194 "keepalive" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2195 "zombies" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2196 "zone" : "upstream_backend" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2197 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2198 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2199 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2200 <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
|
2201 <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
|
2202 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
|
2203 <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
|
2204 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2205 <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
|
2206 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2207 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2208 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
|
2209 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2210 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2211 <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
|
2212 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2213 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2214 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#address">address</link> parameter of the HTTP upstream server. When adding a server, it is possible to specify it as a domain name. In this case, changes of the IP addresses that correspond to a domain name will be monitored and automatically applied to the upstream configuration without the need of restarting nginx. This requires the <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver">resolver</link> directive in the “<literal>http</literal>” block. See also the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#resolve">resolve</link> parameter of the HTTP upstream server. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2215 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2216 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2217 <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
|
2218 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2219 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2220 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
|
2221 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2222 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2223 <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
|
2224 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2225 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2226 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
|
2227 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2228 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2229 <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
|
2230 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2231 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2232 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
|
2233 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2234 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2235 <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
|
2236 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2237 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2238 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
|
2239 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2240 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2241 <literal>fail_timeout</literal> (<literal>integer</literal>) |
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 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2244 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
|
2245 </tag-desc> |
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>slow_start</literal> (<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> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2250 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
|
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>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
|
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> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2256 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
|
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 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2259 <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
|
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 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2262 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
|
2263 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2264 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2265 <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
|
2266 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2267 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2268 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
|
2269 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2270 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2271 <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
|
2272 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2273 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2274 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
|
2275 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2276 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2277 <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
|
2278 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2279 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2280 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
|
2281 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2282 <tag-name> |
2072
116994597b0e
Changed the type of the "drain" parameter to boolean.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2047
diff
changeset
|
2283 <literal>drain</literal> (<literal>boolean</literal>) |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2284 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2285 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2286 Puts the HTTP upstream server into the “draining” mode. In this mode, only requests <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#sticky">bound</link> to the server will be proxied to it. The parameter cannot be initially set, it can only be changed with the <literal>PATCH</literal> method. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2287 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2288 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2289 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2290 <example> |
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 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2293 "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
|
2294 "weight" : 4, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2295 "max_conns" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2296 "max_fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2297 "fail_timeout" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2298 "slow_start" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2299 "route" : "", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2300 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2301 "down" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2302 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2303 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2304 <listitem id="def_nginx_http_keyval_zone"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2305 <para>Keyval Shared Memory Zone:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2306 Contents of a keyval shared memory zone.<para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2307 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2308 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2309 "key1" : "value1", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2310 "key2" : "value2", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2311 "key3" : "value3" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2312 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2313 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2314 <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
|
2315 <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
|
2316 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2317 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2318 <literal>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
|
2319 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2320 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2321 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
|
2322 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2323 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2324 <literal>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
|
2325 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2326 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2327 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
|
2328 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2329 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2330 <literal>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
|
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 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
|
2333 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2334 <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
|
2335 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2336 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2337 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
|
2338 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2339 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2340 <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
|
2341 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2342 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2343 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
|
2344 </tag-desc> |
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>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
|
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> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2349 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
|
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>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
|
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 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
|
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 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2359 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2360 <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
|
2361 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2362 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2363 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
|
2364 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2365 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2366 <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
|
2367 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2368 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2369 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
|
2370 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2371 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2372 <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
|
2373 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2374 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2375 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
|
2376 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2377 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2378 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2379 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2380 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2381 "dns" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2382 "processing" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2383 "connections" : 155569, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2384 "sessions" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2385 "2xx" : 155564, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2386 "4xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2387 "5xx" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2388 "total" : 155569 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2389 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2390 "discarded" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2391 "received" : 4200363, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2392 "sent" : 20489184 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2393 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2394 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2395 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2396 <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
|
2397 <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
|
2398 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2399 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2400 <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
|
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 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
|
2403 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2404 <literal>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
|
2405 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2406 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2407 The 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
|
2408 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2409 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2410 <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
|
2411 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2412 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2413 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
|
2414 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2415 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2416 <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
|
2417 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2418 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2419 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
|
2420 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2421 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2422 <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
|
2423 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2424 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2425 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
|
2426 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2427 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2428 <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
|
2429 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2430 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2431 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
|
2432 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2433 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2434 <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
|
2435 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2436 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2437 <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
|
2438 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2439 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2440 <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
|
2441 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2442 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2443 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
|
2444 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2445 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2446 <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
|
2447 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2448 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2449 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
|
2450 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2451 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2452 <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
|
2453 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2454 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2455 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
|
2456 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2457 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2458 <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
|
2459 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2460 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2461 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
|
2462 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2463 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2464 <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
|
2465 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2466 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2467 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
|
2468 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2469 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2470 <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
|
2471 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2472 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2473 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
|
2474 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2475 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2476 <literal>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
|
2477 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2478 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2479 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
|
2480 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2481 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2482 <literal>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
|
2483 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2484 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2485 The total number of bytes 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
|
2486 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2487 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2488 <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
|
2489 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2490 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2491 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
|
2492 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2493 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2494 <literal>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
|
2495 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2496 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2497 The total number of 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
|
2498 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2499 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2500 <literal>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
|
2501 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2502 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2503 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
|
2504 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2505 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2506 <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
|
2507 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2508 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2509 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2510 <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
|
2511 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2512 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2513 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
|
2514 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2515 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2516 <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
|
2517 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2518 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2519 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
|
2520 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2521 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2522 <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
|
2523 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2524 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2525 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
|
2526 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2527 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2528 <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
|
2529 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2530 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2531 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
|
2532 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2533 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2534 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2535 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2536 <literal>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
|
2537 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2538 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2539 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
|
2540 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2541 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2542 <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
|
2543 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2544 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2545 The time (in milliseconds since Epoch) when the server became “<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
|
2546 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2547 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2548 <literal>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
|
2549 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2550 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2551 The time (in milliseconds since Epoch) when the server was last selected to process a connection. |
2034
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2552 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2553 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2554 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2555 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2556 <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
|
2557 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2558 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2559 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
|
2560 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2561 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2562 <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
|
2563 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2564 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2565 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
|
2566 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2567 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2568 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2569 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2570 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2571 "dns" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2572 "peers" : [ |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2573 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2574 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2575 "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
|
2576 "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
|
2577 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2578 "weight" : 5, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2579 "state" : "up", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2580 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2581 "max_conns" : 50, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2582 "connections" : 667231, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2583 "sent" : 251946292, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2584 "received" : 19222475454, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2585 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2586 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2587 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2588 "checks" : 26214, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2589 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2590 "unhealthy" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2591 "last_passed" : true |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2592 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2593 "downtime" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2594 "downstart" : "2017-07-07T11:09:21.602Z", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2595 "selected" : "2017-07-17T15:01:25.000Z" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2596 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2597 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2598 "id" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2599 "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
|
2600 "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
|
2601 "backup" : true, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2602 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2603 "state" : "unhealthy", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2604 "active" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2605 "max_conns" : 50, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2606 "connections" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2607 "sent" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2608 "received" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2609 "fails" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2610 "unavail" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2611 "health_checks" : { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2612 "checks" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2613 "fails" : 26284, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2614 "unhealthy" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2615 "last_passed" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2616 }, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2617 "downtime" : 262925617, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2618 "downstart" : "2017-07-07T11:09:21.602Z", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2619 "selected" : "2017-07-17T15:01:25.000Z" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2620 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2621 ], |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2622 "zombies" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2623 "zone" : "dns" |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2624 } |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2625 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2626 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2627 <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
|
2628 <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
|
2629 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
|
2630 <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
|
2631 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2632 <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
|
2633 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2634 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2635 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
|
2636 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2637 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2638 <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
|
2639 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2640 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2641 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
|
2642 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2643 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2644 <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
|
2645 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2646 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2647 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
|
2648 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2649 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2650 <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
|
2651 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2652 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2653 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
|
2654 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2655 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2656 <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
|
2657 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2658 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2659 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
|
2660 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2661 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2662 <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
|
2663 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2664 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2665 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
|
2666 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2667 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2668 <literal>fail_timeout</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2669 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2670 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2671 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
|
2672 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2673 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2674 <literal>slow_start</literal> (<literal>integer</literal>) |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2675 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2676 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2677 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
|
2678 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2679 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2680 <literal>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
|
2681 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2682 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2683 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
|
2684 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2685 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2686 <literal>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
|
2687 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2688 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2689 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
|
2690 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2691 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2692 <literal>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
|
2693 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2694 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2695 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
|
2696 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2697 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2698 <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
|
2699 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2700 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2701 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
|
2702 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2703 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2704 <para>Example:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2705 <example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2706 { |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2707 "id" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2708 "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
|
2709 "weight" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2710 "max_conns" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2711 "max_fails" : 1, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2712 "fail_timeout" : "10s", |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2713 "slow_start" : 0, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2714 "backup" : false, |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2715 "down" : false |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2716 }</example> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2717 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2718 <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
|
2719 <para>Error:</para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2720 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
|
2721 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2722 <literal>path</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
|
2723 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2724 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2725 API path. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2726 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2727 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2728 <literal>method</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
|
2729 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2730 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2731 HTTP method. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2732 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2733 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2734 <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
|
2735 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2736 <list type="tag"> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2737 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2738 <literal>status</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
|
2739 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2740 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2741 HTTP error code. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2742 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2743 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2744 <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
|
2745 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2746 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2747 Error description. |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2748 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2749 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2750 <literal>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
|
2751 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2752 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2753 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
|
2754 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2755 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2756 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2757 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2758 <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
|
2759 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2760 <tag-desc> |
2046
a810103f8a75
Changed summary and description style to flow scalar in yaml.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2034
diff
changeset
|
2761 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
|
2762 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2763 <tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2764 <literal>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
|
2765 </tag-name> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2766 <tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2767 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
|
2768 </tag-desc> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2769 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2770 </listitem> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2771 </list> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2772 </para> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2773 </section> |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2774 |
7e7edf832099
Added the generated ngx_http_api_module and separate target for it.
Vladimir Homutov <vl@nginx.com>
parents:
diff
changeset
|
2775 </module> |