Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_api_module.xml @ 2221:45a2b90247ad
Added "status_zone" to the API module.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 24 Apr 2018 18:55:54 +0300 |
parents | f6e578b1b02d |
children | a89093ff86a3 |
comparison
equal
deleted
inserted
replaced
2220:896562a1ccde | 2221:45a2b90247ad |
---|---|
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
8 | 8 |
9 <module name="Module ngx_http_api_module" | 9 <module name="Module ngx_http_api_module" |
10 link="/en/docs/http/ngx_http_api_module.html" | 10 link="/en/docs/http/ngx_http_api_module.html" |
11 lang="en" | 11 lang="en" |
12 rev="1"> | 12 rev="2"> |
13 | 13 |
14 <section id="summary"> | 14 <section id="summary"> |
15 | 15 |
16 <para> | 16 <para> |
17 The <literal>ngx_http_api_module</literal> module (1.13.3) provides REST API | 17 The <literal>ngx_http_api_module</literal> module (1.13.3) provides REST API |
157 </example> | 157 </example> |
158 </para> | 158 </para> |
159 | 159 |
160 </directive> | 160 </directive> |
161 | 161 |
162 | |
163 <directive name="status_zone"> | |
164 <syntax><value>zone</value></syntax> | |
165 <default/> | |
166 <context>server</context> | |
167 <appeared-in>1.13.12</appeared-in> | |
168 | |
169 <para> | |
170 Enables collection of virtual | |
171 <link doc="ngx_http_core_module.xml" id="server">http</link> | |
172 or | |
173 <link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link> | |
174 server status information in the specified <value>zone</value>. | |
175 Several servers may share the same zone. | |
176 </para> | |
177 | |
178 </directive> | |
179 | |
162 </section> | 180 </section> |
163 | 181 |
164 <section id="compatibility" name="Compatibility"> | 182 <section id="compatibility" name="Compatibility"> |
165 | 183 |
166 <para> | 184 <para> |
471 <tag-desc> | 489 <tag-desc> |
472 <para>Supported methods:</para> | 490 <para>Supported methods:</para> |
473 <list type="bullet" compact="yes"> | 491 <list type="bullet" compact="yes"> |
474 <listitem id="getHttpServerZones"> | 492 <listitem id="getHttpServerZones"> |
475 <literal>GET</literal> - Return status of all HTTP server zones | 493 <literal>GET</literal> - Return status of all HTTP server zones |
476 <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> | 494 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">server zone</link>.</para> |
477 <para> | 495 <para> |
478 Request parameters: | 496 Request parameters: |
479 <list type="tag"> | 497 <list type="tag"> |
480 <tag-name><literal>fields</literal> | 498 <tag-name><literal>fields</literal> |
481 (<literal>string</literal>, optional)</tag-name> | 499 (<literal>string</literal>, optional)</tag-name> |
996 <tag-desc> | 1014 <tag-desc> |
997 <para>Supported methods:</para> | 1015 <para>Supported methods:</para> |
998 <list type="bullet" compact="yes"> | 1016 <list type="bullet" compact="yes"> |
999 <listitem id="getStreamServerZones"> | 1017 <listitem id="getStreamServerZones"> |
1000 <literal>GET</literal> - Return status of all stream server zones | 1018 <literal>GET</literal> - Return status of all stream server zones |
1001 <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> | 1019 <para>Returns status information for each stream <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">server zone</link>.</para> |
1002 <para> | 1020 <para> |
1003 Request parameters: | 1021 Request parameters: |
1004 <list type="tag"> | 1022 <list type="tag"> |
1005 <tag-name><literal>fields</literal> | 1023 <tag-name><literal>fields</literal> |
1006 (<literal>string</literal>, optional)</tag-name> | 1024 (<literal>string</literal>, optional)</tag-name> |