Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_api_module.xml @ 2424:dd3ac7eefeed

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 02 Sep 2019 14:12:20 +0300
parents d5e576eb7677
children 12716b241230
comparison
equal deleted inserted replaced
2423:21f1376238b0 2424:dd3ac7eefeed
99 </example> 99 </example>
100 All API requests include 100 All API requests include
101 a supported API <link id="api_version">version</link> in the URI. 101 a supported API <link id="api_version">version</link> in the URI.
102 Examples of API requests with this configuration: 102 Examples of API requests with this configuration:
103 <example> 103 <example>
104 http://127.0.0.1/api/4/ 104 http://127.0.0.1/api/5/
105 http://127.0.0.1/api/4/nginx 105 http://127.0.0.1/api/5/nginx
106 http://127.0.0.1/api/4/connections 106 http://127.0.0.1/api/5/connections
107 http://127.0.0.1/api/4/http/requests 107 http://127.0.0.1/api/5/http/requests
108 http://127.0.0.1/api/4/http/server_zones/server_backend 108 http://127.0.0.1/api/5/http/server_zones/server_backend
109 http://127.0.0.1/api/4/http/caches/cache_backend 109 http://127.0.0.1/api/5/http/caches/cache_backend
110 http://127.0.0.1/api/4/http/upstreams/backend 110 http://127.0.0.1/api/5/http/upstreams/backend
111 http://127.0.0.1/api/4/http/upstreams/backend/servers/ 111 http://127.0.0.1/api/5/http/upstreams/backend/servers/
112 http://127.0.0.1/api/4/http/upstreams/backend/servers/1 112 http://127.0.0.1/api/5/http/upstreams/backend/servers/1
113 http://127.0.0.1/api/4/http/keyvals/one?key=arg1 113 http://127.0.0.1/api/5/http/keyvals/one?key=arg1
114 http://127.0.0.1/api/4/stream/ 114 http://127.0.0.1/api/5/stream/
115 http://127.0.0.1/api/4/stream/server_zones/server_backend 115 http://127.0.0.1/api/5/stream/server_zones/server_backend
116 http://127.0.0.1/api/4/stream/upstreams/ 116 http://127.0.0.1/api/5/stream/upstreams/
117 http://127.0.0.1/api/4/stream/upstreams/backend 117 http://127.0.0.1/api/5/stream/upstreams/backend
118 http://127.0.0.1/api/4/stream/upstreams/backend/servers/1 118 http://127.0.0.1/api/5/stream/upstreams/backend/servers/1
119 </example> 119 </example>
120 </para> 120 </para>
121 121
122 </section> 122 </section>
123 123
144 144
145 <para id="api_version"> 145 <para id="api_version">
146 All API requests should contain a supported API version in the URI. 146 All API requests should contain a supported API version in the URI.
147 If the request URI equals the location prefix, 147 If the request URI equals the location prefix,
148 the list of supported API versions is returned. 148 the list of supported API versions is returned.
149 The current API version is “<literal>4</literal>”. 149 The current API version is “<literal>5</literal>”.
150 </para> 150 </para>
151 151
152 <para> 152 <para>
153 The optional “<literal>fields</literal>” argument in the request line 153 The optional “<literal>fields</literal>” argument in the request line
154 specifies which fields of the requested objects will be output: 154 specifies which fields of the requested objects will be output:
155 <example> 155 <example>
156 http://127.0.0.1/api/4/nginx?fields=version,build 156 http://127.0.0.1/api/5/nginx?fields=version,build
157 </example> 157 </example>
158 </para> 158 </para>
159 159
160 </directive> 160 </directive>
161 161
162 162
163 <directive name="status_zone"> 163 <directive name="status_zone">
164 <syntax><value>zone</value></syntax> 164 <syntax><value>zone</value></syntax>
165 <default/> 165 <default/>
166 <context>server</context> 166 <context>server</context>
167 <context>location</context>
168 <context>if in location</context>
167 <appeared-in>1.13.12</appeared-in> 169 <appeared-in>1.13.12</appeared-in>
168 170
169 <para> 171 <para>
170 Enables collection of virtual 172 Enables collection of virtual
171 <link doc="ngx_http_core_module.xml" id="server">http</link> 173 <link doc="ngx_http_core_module.xml" id="server">http</link>
173 <link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link> 175 <link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link>
174 server status information in the specified <value>zone</value>. 176 server status information in the specified <value>zone</value>.
175 Several servers may share the same zone. 177 Several servers may share the same zone.
176 </para> 178 </para>
177 179
180 <para id="status_zone_location">
181 Starting from 1.17.0, status information can be collected
182 per <link doc="ngx_http_core_module.xml" id="location"/>.
183 The special value <literal>off</literal> disables statistics collection
184 in nested location blocks.
185 Note that the statistics is collected
186 in the context of a location where processing ends.
187 It may be different from the original location, if an
188 <link doc="ngx_http_core_module.xml" id="internal">internal
189 redirect</link> happens during request processing.
190 </para>
191
178 </directive> 192 </directive>
179 193
180 </section> 194 </section>
181 195
182 <section id="compatibility" name="Compatibility"> 196 <section id="compatibility" name="Compatibility">
183 197
184 <para> 198 <para>
185 <list type="bullet"> 199 <list type="bullet">
200
201 <listitem>
202 The “<literal>expire</literal>” parameter of a
203 <link doc="ngx_http_keyval_module.xml">key-value</link> pair can be
204 <link id="postHttpKeyvalZoneData">set</link> or
205 <link id="patchHttpKeyvalZoneKeyValue">changed</link>
206 since <link id="api_version">version</link> 5.
207 </listitem>
208
209 <listitem>
210 The <link id="resolvers_">/resolvers/</link> data
211 were added in <link id="api_version">version</link> 5.
212 </listitem>
213
214 <listitem>
215 The <link id="http_location_zones_">/http/location_zones/</link> data
216 were added in <link id="api_version">version</link> 5.
217 </listitem>
186 218
187 <listitem> 219 <listitem>
188 The <literal>path</literal> and <literal>method</literal> fields of 220 The <literal>path</literal> and <literal>method</literal> fields of
189 <link id="def_nginx_error">nginx error object</link> 221 <link id="def_nginx_error">nginx error object</link>
190 were removed in <link id="api_version">version</link> 4. 222 were removed in <link id="api_version">version</link> 4.
322 <listitem>204 - Success</listitem> 354 <listitem>204 - Success</listitem>
323 </list> 355 </list>
324 </listitem> 356 </listitem>
325 </list> 357 </list>
326 </tag-desc> 358 </tag-desc>
327 <tag-name id="ssl" name="/ssl">
328 <literal>/ssl</literal>
329 </tag-name>
330 <tag-desc>
331 <para>Supported methods:</para>
332 <list type="bullet" compact="yes">
333 <listitem id="getSsl">
334 <literal>GET</literal> - Return SSL statistics
335 <para>Returns SSL statistics.</para>
336 <para>
337 Request parameters:
338 <list type="tag">
339 <tag-name><literal>fields</literal>
340 (<literal>string</literal>, optional)</tag-name>
341 <tag-desc>
342 Limits which fields of SSL statistics will be output.</tag-desc>
343 </list>
344 </para>
345 <para>
346 Possible responses:
347 </para>
348 <list type="bullet">
349 <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem>
350 </list>
351 </listitem>
352 <listitem id="deleteSslStat">
353 <literal>DELETE</literal> - Reset SSL statistics
354 <para>Resets counters of SSL handshakes and session reuses.</para>
355 <para>
356 Possible responses:
357 </para>
358 <list type="bullet">
359 <listitem>204 - Success</listitem>
360 </list>
361 </listitem>
362 </list>
363 </tag-desc>
364 <tag-name id="slabs_" name="/slabs/"> 359 <tag-name id="slabs_" name="/slabs/">
365 <literal>/slabs/</literal> 360 <literal>/slabs/</literal>
366 </tag-name> 361 </tag-name>
367 <tag-desc> 362 <tag-desc>
368 <para>Supported methods:</para> 363 <para>Supported methods:</para>
374 Request parameters: 369 Request parameters:
375 <list type="tag"> 370 <list type="tag">
376 <tag-name><literal>fields</literal> 371 <tag-name><literal>fields</literal>
377 (<literal>string</literal>, optional)</tag-name> 372 (<literal>string</literal>, optional)</tag-name>
378 <tag-desc> 373 <tag-desc>
379 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> 374 Limits which fields of slab zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc>
380 </list> 375 </list>
381 </para> 376 </para>
382 <para> 377 <para>
383 Possible responses: 378 Possible responses:
384 </para> 379 </para>
385 <list type="bullet"> 380 <list type="bullet">
386 <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> 381 <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>
387 </list> 382 </list>
388 </listitem> 383 </listitem>
389 </list> 384 </list>
390 </tag-desc> 385 </tag-desc>
391 <tag-name id="slabs_slab_zone_name" name="/slabs/{slabZoneName}"> 386 <tag-name id="slabs_slab_zone_name" name="/slabs/{slabZoneName}">
504 Request parameters: 499 Request parameters:
505 <list type="tag"> 500 <list type="tag">
506 <tag-name><literal>fields</literal> 501 <tag-name><literal>fields</literal>
507 (<literal>string</literal>, optional)</tag-name> 502 (<literal>string</literal>, optional)</tag-name>
508 <tag-desc> 503 <tag-desc>
509 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> 504 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names will be output.</tag-desc>
510 </list> 505 </list>
511 </para> 506 </para>
512 <para> 507 <para>
513 Possible responses: 508 Possible responses:
514 </para> 509 </para>
515 <list type="bullet"> 510 <list type="bullet">
516 <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> 511 <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>
517 </list> 512 </list>
518 </listitem> 513 </listitem>
519 </list> 514 </list>
520 </tag-desc> 515 </tag-desc>
521 <tag-name id="http_server_zones_http_server_zone_name" name="/http/server_zones/{httpServerZoneName}"> 516 <tag-name id="http_server_zones_http_server_zone_name" name="/http/server_zones/{httpServerZoneName}">
563 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 558 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
564 </list> 559 </list>
565 </listitem> 560 </listitem>
566 </list> 561 </list>
567 </tag-desc> 562 </tag-desc>
563 <tag-name id="http_location_zones_" name="/http/location_zones/">
564 <literal>/http/location_zones/</literal>
565 </tag-name>
566 <tag-desc>
567 <para>Supported methods:</para>
568 <list type="bullet" compact="yes">
569 <listitem id="getHttpLocationZones">
570 <literal>GET</literal> - Return status of all HTTP location zones
571 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</para>
572 <para>
573 Request parameters:
574 <list type="tag">
575 <tag-name><literal>fields</literal>
576 (<literal>string</literal>, optional)</tag-name>
577 <tag-desc>
578 Limits which fields of location zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc>
579 </list>
580 </para>
581 <para>
582 Possible responses:
583 </para>
584 <list type="bullet">
585 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_location_zone">HTTP Location Zone</link>" objects for all HTTP location zones</listitem>
586 </list>
587 </listitem>
588 </list>
589 </tag-desc>
590 <tag-name id="http_location_zones_http_location_zone_name" name="/http/location_zones/{httpLocationZoneName}">
591 <literal>/http/location_zones/{httpLocationZoneName}</literal>
592 </tag-name>
593 <tag-desc>
594 Parameters common for all methods:
595 <list type="tag">
596 <tag-name><literal>httpLocationZoneName</literal>
597 (<literal>string</literal>, required)</tag-name>
598 <tag-desc>
599 The name of an HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</tag-desc>
600 </list>
601 <para>Supported methods:</para>
602 <list type="bullet" compact="yes">
603 <listitem id="getHttpLocationZone">
604 <literal>GET</literal> - Return status of an HTTP location zone
605 <para>Returns status of a particular HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</para>
606 <para>
607 Request parameters:
608 <list type="tag">
609 <tag-name><literal>fields</literal>
610 (<literal>string</literal>, optional)</tag-name>
611 <tag-desc>
612 Limits which fields of the location zone will be output.</tag-desc>
613 </list>
614 </para>
615 <para>
616 Possible responses:
617 </para>
618 <list type="bullet">
619 <listitem>200 - Success, returns <link id="def_nginx_http_location_zone">HTTP Location Zone</link></listitem>
620 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
621 </list>
622 </listitem>
623 <listitem id="deleteHttpLocationZoneStat">
624 <literal>DELETE</literal> - Reset statistics for a location zone.
625 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular location zone.</para>
626 <para>
627 Possible responses:
628 </para>
629 <list type="bullet">
630 <listitem>204 - Success</listitem>
631 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
632 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
633 </list>
634 </listitem>
635 </list>
636 </tag-desc>
568 <tag-name id="http_caches_" name="/http/caches/"> 637 <tag-name id="http_caches_" name="/http/caches/">
569 <literal>/http/caches/</literal> 638 <literal>/http/caches/</literal>
570 </tag-name> 639 </tag-name>
571 <tag-desc> 640 <tag-desc>
572 <para>Supported methods:</para> 641 <para>Supported methods:</para>
578 Request parameters: 647 Request parameters:
579 <list type="tag"> 648 <list type="tag">
580 <tag-name><literal>fields</literal> 649 <tag-name><literal>fields</literal>
581 (<literal>string</literal>, optional)</tag-name> 650 (<literal>string</literal>, optional)</tag-name>
582 <tag-desc> 651 <tag-desc>
583 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> 652 Limits which fields of cache zones will be output. If the “<literal>fields</literal>” value is empty, then only names of cache zones will be output.</tag-desc>
584 </list> 653 </list>
585 </para> 654 </para>
586 <para> 655 <para>
587 Possible responses: 656 Possible responses:
588 </para> 657 </para>
589 <list type="bullet"> 658 <list type="bullet">
590 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_cache">HTTP Cache</link>" objects for all http caches </listitem> 659 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_cache">HTTP Cache</link>" objects for all HTTP caches</listitem>
591 </list> 660 </list>
592 </listitem> 661 </listitem>
593 </list> 662 </list>
594 </tag-desc> 663 </tag-desc>
595 <tag-name id="http_caches_http_cache_zone_name" name="/http/caches/{httpCacheZoneName}"> 664 <tag-name id="http_caches_http_cache_zone_name" name="/http/caches/{httpCacheZoneName}">
652 Request parameters: 721 Request parameters:
653 <list type="tag"> 722 <list type="tag">
654 <tag-name><literal>fields</literal> 723 <tag-name><literal>fields</literal>
655 (<literal>string</literal>, optional)</tag-name> 724 (<literal>string</literal>, optional)</tag-name>
656 <tag-desc> 725 <tag-desc>
657 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> 726 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams will be output.</tag-desc>
658 </list> 727 </list>
659 </para> 728 </para>
660 <para> 729 <para>
661 Possible responses: 730 Possible responses:
662 </para> 731 </para>
663 <list type="bullet"> 732 <list type="bullet">
664 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_upstream">HTTP Upstream</link>" objects for all http upstreams </listitem> 733 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_upstream">HTTP Upstream</link>" objects for all HTTP upstreams</listitem>
665 </list> 734 </list>
666 </listitem> 735 </listitem>
667 </list> 736 </list>
668 </tag-desc> 737 </tag-desc>
669 <tag-name id="http_upstreams_http_upstream_name_" name="/http/upstreams/{httpUpstreamName}/"> 738 <tag-name id="http_upstreams_http_upstream_name_" name="/http/upstreams/{httpUpstreamName}/">
884 Request parameters: 953 Request parameters:
885 <list type="tag"> 954 <list type="tag">
886 <tag-name><literal>fields</literal> 955 <tag-name><literal>fields</literal>
887 (<literal>string</literal>, optional)</tag-name> 956 (<literal>string</literal>, optional)</tag-name>
888 <tag-desc> 957 <tag-desc>
889 If the “<literal>fields</literal>” value is empty, then only HTTP keyval zone names are output.</tag-desc> 958 If the “<literal>fields</literal>” value is empty, then only HTTP keyval zone names will be output.</tag-desc>
890 </list> 959 </list>
891 </para> 960 </para>
892 <para> 961 <para>
893 Possible responses: 962 Possible responses:
894 </para> 963 </para>
895 <list type="bullet"> 964 <list type="bullet">
896 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link>" objects for all http keyvals </listitem> 965 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link>" objects for all HTTP keyvals</listitem>
897 </list> 966 </list>
898 </listitem> 967 </listitem>
899 </list> 968 </list>
900 </tag-desc> 969 </tag-desc>
901 <tag-name id="http_keyvals_http_keyval_zone_name" name="/http/keyvals/{httpKeyvalZoneName}"> 970 <tag-name id="http_keyvals_http_keyval_zone_name" name="/http/keyvals/{httpKeyvalZoneName}">
937 <para>Adds a new key-value pair to the HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty.</para> 1006 <para>Adds a new key-value pair to the HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty.</para>
938 <para> 1007 <para>
939 Request parameters: 1008 Request parameters:
940 <list type="tag"> 1009 <list type="tag">
941 <tag-name><literal>Key-value</literal> 1010 <tag-name><literal>Key-value</literal>
942 (<link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link>, required)</tag-name> 1011 (<link id="def_nginx_http_keyval_zone_post_patch">HTTP Keyval Shared Memory Zone</link>, required)</tag-name>
943 <tag-desc> 1012 <tag-desc>
944 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty.</tag-desc> 1013 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</link> directive.</tag-desc>
945 </list> 1014 </list>
946 </para> 1015 </para>
947 <para> 1016 <para>
948 Possible responses: 1017 Possible responses:
949 </para> 1018 </para>
950 <list type="bullet"> 1019 <list type="bullet">
951 <listitem>201 - Created</listitem> 1020 <listitem>201 - Created</listitem>
952 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), 1021 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
953 only one key can be added (<literal>KeyvalFormatError</literal>), 1022 invalid key format (<literal>KeyvalFormatError</literal>),
954 nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1023 key required (<literal>KeyvalFormatError</literal>),
1024 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1025 only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
955 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1026 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
956 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1027 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
957 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1028 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
958 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1029 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
959 </list> 1030 </list>
960 </listitem> 1031 </listitem>
961 <listitem id="patchHttpKeyvalZoneKeyValue"> 1032 <listitem id="patchHttpKeyvalZoneKeyValue">
962 <literal>PATCH</literal> - Modify a key-value or delete a key 1033 <literal>PATCH</literal> - Modify a key-value or delete a key
963 <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>. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node.</para> 1034 <para>Changes the value of the selected key in the key-value pair, deletes a key by setting the key value to <literal>null</literal>, changes expiration time of a key-value pair. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</link> directive.</para>
964 <para> 1035 <para>
965 Request parameters: 1036 Request parameters:
966 <list type="tag"> 1037 <list type="tag">
967 <tag-name><literal>httpKeyvalZoneKeyValue</literal> 1038 <tag-name><literal>httpKeyvalZoneKeyValue</literal>
968 (<link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link>, required)</tag-name> 1039 (<link id="def_nginx_http_keyval_zone_post_patch">HTTP Keyval Shared Memory Zone</link>, required)</tag-name>
969 <tag-desc> 1040 <tag-desc>
970 A new value for the key is specified in the JSON format.</tag-desc> 1041 A new value for the key is specified in the JSON format.</tag-desc>
971 </list> 1042 </list>
972 </para> 1043 </para>
973 <para> 1044 <para>
974 Possible responses: 1045 Possible responses:
975 </para> 1046 </para>
976 <list type="bullet"> 1047 <list type="bullet">
977 <listitem>204 - Success</listitem> 1048 <listitem>204 - Success</listitem>
978 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), 1049 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
979 only one key can be updated (<literal>KeyvalFormatError</literal>), 1050 key required (<literal>KeyvalFormatError</literal>),
980 nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1051 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1052 only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
981 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1053 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
982 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1054 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
983 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1055 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
984 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1056 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
985 </list> 1057 </list>
1029 Request parameters: 1101 Request parameters:
1030 <list type="tag"> 1102 <list type="tag">
1031 <tag-name><literal>fields</literal> 1103 <tag-name><literal>fields</literal>
1032 (<literal>string</literal>, optional)</tag-name> 1104 (<literal>string</literal>, optional)</tag-name>
1033 <tag-desc> 1105 <tag-desc>
1034 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> 1106 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names will be output.</tag-desc>
1035 </list> 1107 </list>
1036 </para> 1108 </para>
1037 <para> 1109 <para>
1038 Possible responses: 1110 Possible responses:
1039 </para> 1111 </para>
1040 <list type="bullet"> 1112 <list type="bullet">
1041 <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> 1113 <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>
1042 </list> 1114 </list>
1043 </listitem> 1115 </listitem>
1044 </list> 1116 </list>
1045 </tag-desc> 1117 </tag-desc>
1046 <tag-name id="stream_server_zones_stream_server_zone_name" name="/stream/server_zones/{streamServerZoneName}"> 1118 <tag-name id="stream_server_zones_stream_server_zone_name" name="/stream/server_zones/{streamServerZoneName}">
1103 Request parameters: 1175 Request parameters:
1104 <list type="tag"> 1176 <list type="tag">
1105 <tag-name><literal>fields</literal> 1177 <tag-name><literal>fields</literal>
1106 (<literal>string</literal>, optional)</tag-name> 1178 (<literal>string</literal>, optional)</tag-name>
1107 <tag-desc> 1179 <tag-desc>
1108 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> 1180 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams will be output.</tag-desc>
1109 </list> 1181 </list>
1110 </para> 1182 </para>
1111 <para> 1183 <para>
1112 Possible responses: 1184 Possible responses:
1113 </para> 1185 </para>
1114 <list type="bullet"> 1186 <list type="bullet">
1115 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams </listitem> 1187 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams</listitem>
1116 </list> 1188 </list>
1117 </listitem> 1189 </listitem>
1118 </list> 1190 </list>
1119 </tag-desc> 1191 </tag-desc>
1120 <tag-name id="stream_upstreams_stream_upstream_name_" name="/stream/upstreams/{streamUpstreamName}/"> 1192 <tag-name id="stream_upstreams_stream_upstream_name_" name="/stream/upstreams/{streamUpstreamName}/">
1335 Request parameters: 1407 Request parameters:
1336 <list type="tag"> 1408 <list type="tag">
1337 <tag-name><literal>fields</literal> 1409 <tag-name><literal>fields</literal>
1338 (<literal>string</literal>, optional)</tag-name> 1410 (<literal>string</literal>, optional)</tag-name>
1339 <tag-desc> 1411 <tag-desc>
1340 If the “<literal>fields</literal>” value is empty, then only stream keyval zone names are output.</tag-desc> 1412 If the “<literal>fields</literal>” value is empty, then only stream keyval zone names will be output.</tag-desc>
1341 </list> 1413 </list>
1342 </para> 1414 </para>
1343 <para> 1415 <para>
1344 Possible responses: 1416 Possible responses:
1345 </para> 1417 </para>
1346 <list type="bullet"> 1418 <list type="bullet">
1347 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link>" objects for all stream keyvals </listitem> 1419 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link>" objects for all stream keyvals</listitem>
1348 </list> 1420 </list>
1349 </listitem> 1421 </listitem>
1350 </list> 1422 </list>
1351 </tag-desc> 1423 </tag-desc>
1352 <tag-name id="stream_keyvals_stream_keyval_zone_name" name="/stream/keyvals/{streamKeyvalZoneName}"> 1424 <tag-name id="stream_keyvals_stream_keyval_zone_name" name="/stream/keyvals/{streamKeyvalZoneName}">
1388 <para>Adds a new key-value pair to the stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the stream keyval shared memory zone is empty.</para> 1460 <para>Adds a new key-value pair to the stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the stream keyval shared memory zone is empty.</para>
1389 <para> 1461 <para>
1390 Request parameters: 1462 Request parameters:
1391 <list type="tag"> 1463 <list type="tag">
1392 <tag-name><literal>Key-value</literal> 1464 <tag-name><literal>Key-value</literal>
1393 (<link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link>, required)</tag-name> 1465 (<link id="def_nginx_stream_keyval_zone_post_patch">Stream Keyval Shared Memory Zone</link>, required)</tag-name>
1394 <tag-desc> 1466 <tag-desc>
1395 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the stream keyval shared memory zone is empty.</tag-desc> 1467 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the stream keyval shared memory zone is empty. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</link> directive.</tag-desc>
1396 </list> 1468 </list>
1397 </para> 1469 </para>
1398 <para> 1470 <para>
1399 Possible responses: 1471 Possible responses:
1400 </para> 1472 </para>
1401 <list type="bullet"> 1473 <list type="bullet">
1402 <listitem>201 - Created</listitem> 1474 <listitem>201 - Created</listitem>
1403 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), 1475 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
1404 only one key can be added (<literal>KeyvalFormatError</literal>), 1476 invalid key format (<literal>KeyvalFormatError</literal>),
1405 nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1477 key required (<literal>KeyvalFormatError</literal>),
1478 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1479 only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1406 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1480 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1407 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1481 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1408 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1482 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1409 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1483 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1410 </list> 1484 </list>
1411 </listitem> 1485 </listitem>
1412 <listitem id="patchStreamKeyvalZoneKeyValue"> 1486 <listitem id="patchStreamKeyvalZoneKeyValue">
1413 <literal>PATCH</literal> - Modify a key-value or delete a key 1487 <literal>PATCH</literal> - Modify a key-value or delete a key
1414 <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>. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node.</para> 1488 <para>Changes the value of the selected key in the key-value pair, deletes a key by setting the key value to <literal>null</literal>, changes expiration time of a key-value pair. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node. Expiration time is specified in milliseconds with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</link> directive.</para>
1415 <para> 1489 <para>
1416 Request parameters: 1490 Request parameters:
1417 <list type="tag"> 1491 <list type="tag">
1418 <tag-name><literal>streamKeyvalZoneKeyValue</literal> 1492 <tag-name><literal>streamKeyvalZoneKeyValue</literal>
1419 (<link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link>, required)</tag-name> 1493 (<link id="def_nginx_stream_keyval_zone_post_patch">Stream Keyval Shared Memory Zone</link>, required)</tag-name>
1420 <tag-desc> 1494 <tag-desc>
1421 A new value for the key is specified in the JSON format.</tag-desc> 1495 A new value for the key is specified in the JSON format.</tag-desc>
1422 </list> 1496 </list>
1423 </para> 1497 </para>
1424 <para> 1498 <para>
1425 Possible responses: 1499 Possible responses:
1426 </para> 1500 </para>
1427 <list type="bullet"> 1501 <list type="bullet">
1428 <listitem>204 - Success</listitem> 1502 <listitem>204 - Success</listitem>
1429 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), 1503 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
1430 only one key can be updated (<literal>KeyvalFormatError</literal>), 1504 key required (<literal>KeyvalFormatError</literal>),
1431 nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1505 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1506 only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1432 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1507 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1433 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1508 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1434 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1509 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1435 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1510 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1436 </list> 1511 </list>
1461 <para> 1536 <para>
1462 Possible responses: 1537 Possible responses:
1463 </para> 1538 </para>
1464 <list type="bullet"> 1539 <list type="bullet">
1465 <listitem>200 - Success, returns <link id="def_nginx_stream_zone_sync">Stream Zone Sync Node</link></listitem> 1540 <listitem>200 - Success, returns <link id="def_nginx_stream_zone_sync">Stream Zone Sync Node</link></listitem>
1541 </list>
1542 </listitem>
1543 </list>
1544 </tag-desc>
1545 <tag-name id="resolvers_" name="/resolvers/">
1546 <literal>/resolvers/</literal>
1547 </tag-name>
1548 <tag-desc>
1549 <para>Supported methods:</para>
1550 <list type="bullet" compact="yes">
1551 <listitem id="getResolverZones">
1552 <literal>GET</literal> - Return status for all resolver zones
1553 <para>Returns status information for each <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</link>.</para>
1554 <para>
1555 Request parameters:
1556 <list type="tag">
1557 <tag-name><literal>fields</literal>
1558 (<literal>string</literal>, optional)</tag-name>
1559 <tag-desc>
1560 Limits which fields of resolvers statistics will be output.</tag-desc>
1561 </list>
1562 </para>
1563 <para>
1564 Possible responses:
1565 </para>
1566 <list type="bullet">
1567 <listitem>200 - Success, returns a collection of "<link id="def_nginx_resolver_zone">Resolver Zone</link>" objects for all resolvers</listitem>
1568 </list>
1569 </listitem>
1570 </list>
1571 </tag-desc>
1572 <tag-name id="resolvers_resolver_zone_name" name="/resolvers/{resolverZoneName}">
1573 <literal>/resolvers/{resolverZoneName}</literal>
1574 </tag-name>
1575 <tag-desc>
1576 Parameters common for all methods:
1577 <list type="tag">
1578 <tag-name><literal>resolverZoneName</literal>
1579 (<literal>string</literal>, required)</tag-name>
1580 <tag-desc>
1581 The name of a resolver zone.</tag-desc>
1582 </list>
1583 <para>Supported methods:</para>
1584 <list type="bullet" compact="yes">
1585 <listitem id="getResolverZone">
1586 <literal>GET</literal> - Return statistics of a resolver zone
1587 <para>Returns statistics stored in a particular resolver <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">zone</link>.</para>
1588 <para>
1589 Request parameters:
1590 <list type="tag">
1591 <tag-name><literal>fields</literal>
1592 (<literal>string</literal>, optional)</tag-name>
1593 <tag-desc>
1594 Limits which fields of the resolver zone will be output (requests, responses, or both).</tag-desc>
1595 </list>
1596 </para>
1597 <para>
1598 Possible responses:
1599 </para>
1600 <list type="bullet">
1601 <listitem>200 - Success, returns <link id="def_nginx_resolver_zone">Resolver Zone</link></listitem>
1602 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1603 </list>
1604 </listitem>
1605 <listitem id="deleteResolverZoneStat">
1606 <literal>DELETE</literal> - Reset statistics for a resolver zone.
1607 <para>Resets statistics in a particular resolver zone.</para>
1608 <para>
1609 Possible responses:
1610 </para>
1611 <list type="bullet">
1612 <listitem>204 - Success</listitem>
1613 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1614 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1615 </list>
1616 </listitem>
1617 </list>
1618 </tag-desc>
1619 <tag-name id="ssl" name="/ssl">
1620 <literal>/ssl</literal>
1621 </tag-name>
1622 <tag-desc>
1623 <para>Supported methods:</para>
1624 <list type="bullet" compact="yes">
1625 <listitem id="getSsl">
1626 <literal>GET</literal> - Return SSL statistics
1627 <para>Returns SSL statistics.</para>
1628 <para>
1629 Request parameters:
1630 <list type="tag">
1631 <tag-name><literal>fields</literal>
1632 (<literal>string</literal>, optional)</tag-name>
1633 <tag-desc>
1634 Limits which fields of SSL statistics will be output.</tag-desc>
1635 </list>
1636 </para>
1637 <para>
1638 Possible responses:
1639 </para>
1640 <list type="bullet">
1641 <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem>
1642 </list>
1643 </listitem>
1644 <listitem id="deleteSslStat">
1645 <literal>DELETE</literal> - Reset SSL statistics
1646 <para>Resets counters of SSL handshakes and session reuses.</para>
1647 <para>
1648 Possible responses:
1649 </para>
1650 <list type="bullet">
1651 <listitem>204 - Success</listitem>
1466 </list> 1652 </list>
1467 </listitem> 1653 </listitem>
1468 </list> 1654 </list>
1469 </tag-desc> 1655 </tag-desc>
1470 </list> 1656 </list>
1827 </list> 2013 </list>
1828 <para>Example:</para> 2014 <para>Example:</para>
1829 <example> 2015 <example>
1830 { 2016 {
1831 "processing" : 1, 2017 "processing" : 1,
2018 "requests" : 706690,
2019 "responses" : {
2020 "1xx" : 0,
2021 "2xx" : 699482,
2022 "3xx" : 4522,
2023 "4xx" : 907,
2024 "5xx" : 266,
2025 "total" : 705177
2026 },
2027 "discarded" : 1513,
2028 "received" : 172711587,
2029 "sent" : 19415530115
2030 }</example>
2031 </listitem>
2032 <listitem id="def_nginx_http_location_zone">
2033 <para>HTTP Location Zone:</para>
2034 <list type="tag">
2035 <tag-name>
2036 <literal>requests</literal> (<literal>integer</literal>)
2037 </tag-name>
2038 <tag-desc>
2039 The total number of client requests received from clients.
2040 </tag-desc>
2041 <tag-name>
2042 <literal>responses</literal></tag-name>
2043 <tag-desc>
2044 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">
2045 <tag-name>
2046 <literal>1xx</literal> (<literal>integer</literal>)
2047 </tag-name>
2048 <tag-desc>
2049 The number of responses with “<literal>1xx</literal>” status codes.
2050 </tag-desc>
2051 <tag-name>
2052 <literal>2xx</literal> (<literal>integer</literal>)
2053 </tag-name>
2054 <tag-desc>
2055 The number of responses with “<literal>2xx</literal>” status codes.
2056 </tag-desc>
2057 <tag-name>
2058 <literal>3xx</literal> (<literal>integer</literal>)
2059 </tag-name>
2060 <tag-desc>
2061 The number of responses with “<literal>3xx</literal>” status codes.
2062 </tag-desc>
2063 <tag-name>
2064 <literal>4xx</literal> (<literal>integer</literal>)
2065 </tag-name>
2066 <tag-desc>
2067 The number of responses with “<literal>4xx</literal>” status codes.
2068 </tag-desc>
2069 <tag-name>
2070 <literal>5xx</literal> (<literal>integer</literal>)
2071 </tag-name>
2072 <tag-desc>
2073 The number of responses with “<literal>5xx</literal>” status codes.
2074 </tag-desc>
2075 <tag-name>
2076 <literal>total</literal> (<literal>integer</literal>)
2077 </tag-name>
2078 <tag-desc>
2079 The total number of responses sent to clients.
2080 </tag-desc>
2081 </list>
2082 </tag-desc>
2083 <tag-name>
2084 <literal>discarded</literal> (<literal>integer</literal>)
2085 </tag-name>
2086 <tag-desc>
2087 The total number of requests completed without sending a response.
2088 </tag-desc>
2089 <tag-name>
2090 <literal>received</literal> (<literal>integer</literal>)
2091 </tag-name>
2092 <tag-desc>
2093 The total number of bytes received from clients.
2094 </tag-desc>
2095 <tag-name>
2096 <literal>sent</literal> (<literal>integer</literal>)
2097 </tag-name>
2098 <tag-desc>
2099 The total number of bytes sent to clients.
2100 </tag-desc>
2101 </list>
2102 <para>Example:</para>
2103 <example>
2104 {
1832 "requests" : 706690, 2105 "requests" : 706690,
1833 "responses" : { 2106 "responses" : {
1834 "1xx" : 0, 2107 "1xx" : 0,
1835 "2xx" : 699482, 2108 "2xx" : 699482,
1836 "3xx" : 4522, 2109 "3xx" : 4522,
2487 "down" : true 2760 "down" : true
2488 }</example> 2761 }</example>
2489 </listitem> 2762 </listitem>
2490 <listitem id="def_nginx_http_keyval_zone"> 2763 <listitem id="def_nginx_http_keyval_zone">
2491 <para>HTTP Keyval Shared Memory Zone:</para> 2764 <para>HTTP Keyval Shared Memory Zone:</para>
2492 Contents of an HTTP keyval shared memory zone.<para>Example:</para> 2765 Contents of an HTTP keyval shared memory zone
2766 when using the GET method.<para>Example:</para>
2493 <example> 2767 <example>
2494 { 2768 {
2495 "key1" : "value1", 2769 "key1" : "value1",
2496 "key2" : "value2", 2770 "key2" : "value2",
2497 "key3" : "value3" 2771 "key3" : "value3"
2772 }</example>
2773 </listitem>
2774 <listitem id="def_nginx_http_keyval_zone_post_patch">
2775 <para>HTTP Keyval Shared Memory Zone:</para>
2776 Contents of an HTTP keyval shared memory zone
2777 when using the POST or PATCH methods.<para>Example:</para>
2778 <example>
2779 {
2780 "key1" : "value1",
2781 "key2" : "value2",
2782 "key3" : {
2783 "value" : "value3",
2784 "expire" : 30000
2785 }
2498 }</example> 2786 }</example>
2499 </listitem> 2787 </listitem>
2500 <listitem id="def_nginx_stream_server_zone"> 2788 <listitem id="def_nginx_stream_server_zone">
2501 <para>Stream Server Zone:</para> 2789 <para>Stream Server Zone:</para>
2502 <list type="tag"> 2790 <list type="tag">
2901 "down" : false 3189 "down" : false
2902 }</example> 3190 }</example>
2903 </listitem> 3191 </listitem>
2904 <listitem id="def_nginx_stream_keyval_zone"> 3192 <listitem id="def_nginx_stream_keyval_zone">
2905 <para>Stream Keyval Shared Memory Zone:</para> 3193 <para>Stream Keyval Shared Memory Zone:</para>
2906 Contents of a stream keyval shared memory zone.<para>Example:</para> 3194 Contents of a stream keyval shared memory zone when using the GET method.<para>Example:</para>
2907 <example> 3195 <example>
2908 { 3196 {
2909 "key1" : "value1", 3197 "key1" : "value1",
2910 "key2" : "value2", 3198 "key2" : "value2",
2911 "key3" : "value3" 3199 "key3" : "value3"
3200 }</example>
3201 </listitem>
3202 <listitem id="def_nginx_stream_keyval_zone_post_patch">
3203 <para>Stream Keyval Shared Memory Zone:</para>
3204 Contents of a stream keyval shared memory zone
3205 when using the POST or PATCH methods.<para>Example:</para>
3206 <example>
3207 {
3208 "key1" : "value1",
3209 "key2" : "value2",
3210 "key3" : {
3211 "value" : "value3",
3212 "expire" : 30000
3213 }
2912 }</example> 3214 }</example>
2913 </listitem> 3215 </listitem>
2914 <listitem id="def_nginx_stream_zone_sync"> 3216 <listitem id="def_nginx_stream_zone_sync">
2915 <para>Stream Zone Sync Node:</para> 3217 <para>Stream Zone Sync Node:</para>
2916 <list type="tag"> 3218 <list type="tag">
2993 <tag-desc> 3295 <tag-desc>
2994 The total number of records stored in the shared memory zone. 3296 The total number of records stored in the shared memory zone.
2995 </tag-desc> 3297 </tag-desc>
2996 </list> 3298 </list>
2997 </listitem> 3299 </listitem>
3300 <listitem id="def_nginx_resolver_zone">
3301 <para>Resolver Zone:</para>
3302 Statistics of DNS requests and responses per particular
3303 <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</link>.<list type="tag">
3304 <tag-name>
3305 <literal>requests</literal></tag-name>
3306 <tag-desc>
3307 <list type="tag">
3308 <tag-name>
3309 <literal>name</literal> (<literal>integer</literal>)
3310 </tag-name>
3311 <tag-desc>
3312 The total number of requests to resolve names to addresses.
3313 </tag-desc>
3314 <tag-name>
3315 <literal>srv</literal> (<literal>integer</literal>)
3316 </tag-name>
3317 <tag-desc>
3318 The total number of requests to resolve SRV records.
3319 </tag-desc>
3320 <tag-name>
3321 <literal>addr</literal> (<literal>integer</literal>)
3322 </tag-name>
3323 <tag-desc>
3324 The total number of requests to resolve addresses to names.
3325 </tag-desc>
3326 </list>
3327 </tag-desc>
3328 <tag-name>
3329 <literal>responses</literal></tag-name>
3330 <tag-desc>
3331 <list type="tag">
3332 <tag-name>
3333 <literal>noerror</literal> (<literal>integer</literal>)
3334 </tag-name>
3335 <tag-desc>
3336 The total number of successful responses.
3337 </tag-desc>
3338 <tag-name>
3339 <literal>formerr</literal> (<literal>integer</literal>)
3340 </tag-name>
3341 <tag-desc>
3342 The total number of FORMERR (<literal>Format error</literal>) responses.
3343 </tag-desc>
3344 <tag-name>
3345 <literal>servfail</literal> (<literal>integer</literal>)
3346 </tag-name>
3347 <tag-desc>
3348 The total number of SERVFAIL (<literal>Server failure</literal>) responses.
3349 </tag-desc>
3350 <tag-name>
3351 <literal>nxdomain</literal> (<literal>integer</literal>)
3352 </tag-name>
3353 <tag-desc>
3354 The total number of NXDOMAIN (<literal>Host not found</literal>) responses.
3355 </tag-desc>
3356 <tag-name>
3357 <literal>notimp</literal> (<literal>integer</literal>)
3358 </tag-name>
3359 <tag-desc>
3360 The total number of NOTIMP (<literal>Unimplemented</literal>) responses.
3361 </tag-desc>
3362 <tag-name>
3363 <literal>refused</literal> (<literal>integer</literal>)
3364 </tag-name>
3365 <tag-desc>
3366 The total number of REFUSED (<literal>Operation refused</literal>) responses.
3367 </tag-desc>
3368 <tag-name>
3369 <literal>timedout</literal> (<literal>integer</literal>)
3370 </tag-name>
3371 <tag-desc>
3372 The total number of timed out requests.
3373 </tag-desc>
3374 <tag-name>
3375 <literal>unknown</literal> (<literal>integer</literal>)
3376 </tag-name>
3377 <tag-desc>
3378 The total number of requests completed with an unknown error.
3379 </tag-desc>
3380 </list>
3381 </tag-desc>
3382 </list>
3383 <para>Example:</para>
3384 <example>
3385 {
3386 "resolver_zone1" : {
3387 "requests" : {
3388 "name" : 25460,
3389 "srv" : 130,
3390 "addr" : 2580
3391 },
3392 "responses" : {
3393 "noerror" : 26499,
3394 "formerr" : 0,
3395 "servfail" : 3,
3396 "nxdomain" : 0,
3397 "notimp" : 0,
3398 "refused" : 0,
3399 "timedout" : 243,
3400 "unknown" : 478
3401 }
3402 }
3403 }</example>
3404 </listitem>
2998 <listitem id="def_nginx_error"> 3405 <listitem id="def_nginx_error">
2999 <para>Error:</para> 3406 <para>Error:</para>
3000 nginx error object.<list type="tag"> 3407 nginx error object.<list type="tag">
3001 <tag-name> 3408 <tag-name>
3002 <literal>error</literal></tag-name> 3409 <literal>error</literal></tag-name>