nginx-site: xml/en/docs/http/ngx_http_api

annotate xml/en/docs/http/ngx_http_api_module.xml @ 2469:98fd810c13e0

Updated docs for the upcoming NGINX Plus release.

author	Ruslan Ermilov <ru@nginx.com>
date	Mon, 02 Dec 2019 13:23:05 +0300
parents	12716b241230
children	407147d8020f

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"
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	12 rev="2">
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	13
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	14 <section id="summary">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	15
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	16 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	17 The <literal>ngx_http_api_module</literal> module (1.13.3) provides REST API
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	18 for accessing various status information,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	19 configuring upstream server groups on-the-fly, and managing
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	20 <link doc="ngx_http_keyval_module.xml">key-value pairs</link>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	21 without the need of reconfiguring nginx.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	22 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	23
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	24 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	25 <note>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	26 The module supersedes the
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	27 <link doc="ngx_http_status_module.xml">ngx_http_status_module</link> and
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	28 <link doc="ngx_http_upstream_conf_module.xml">ngx_http_upstream_conf_module</link>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	29 modules.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	30 </note>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	31 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	32
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	33 <para>
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>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	100 All API requests include
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	101 a supported API <link id="api_version">version</link> in the URI.
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	102 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	103 <example>
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	104 http://127.0.0.1/api/6/
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	105 http://127.0.0.1/api/6/nginx
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	106 http://127.0.0.1/api/6/connections
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	107 http://127.0.0.1/api/6/http/requests
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	108 http://127.0.0.1/api/6/http/server_zones/server_backend
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	109 http://127.0.0.1/api/6/http/caches/cache_backend
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	110 http://127.0.0.1/api/6/http/upstreams/backend
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	111 http://127.0.0.1/api/6/http/upstreams/backend/servers/
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	112 http://127.0.0.1/api/6/http/upstreams/backend/servers/1
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	113 http://127.0.0.1/api/6/http/keyvals/one?key=arg1
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	114 http://127.0.0.1/api/6/stream/
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	115 http://127.0.0.1/api/6/stream/server_zones/server_backend
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	116 http://127.0.0.1/api/6/stream/upstreams/
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	117 http://127.0.0.1/api/6/stream/upstreams/backend
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	118 http://127.0.0.1/api/6/stream/upstreams/backend/servers/1
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	119 </example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	120 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	121
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	122 </section>
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
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	125 <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	126
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	127 <directive name="api">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	128 <syntax>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	129 [<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	130 <default/>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	131 <context>location</context>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	132
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	133 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	134 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	135 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	136 <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	137 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	138
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	139 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	140 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	141 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	142 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	143 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	144
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	145 <para id="api_version">
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	146 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	147 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	148 the list of supported API versions is returned.
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	149 The current API version is “<literal>6</literal>”.
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	150 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	151
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	152 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	153 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	154 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	155 <example>
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	156 http://127.0.0.1/api/6/nginx?fields=version,build
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	157 </example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	158 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	159
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	160 </directive>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	161
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	162
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	163 <directive name="status_zone">
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	164 <syntax><value>zone</value></syntax>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	165 <default/>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	166 <context>server</context>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	167 <context>location</context>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	168 <context>if in location</context>
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	169 <appeared-in>1.13.12</appeared-in>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	170
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	171 <para>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	172 Enables collection of virtual
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	173 <link doc="ngx_http_core_module.xml" id="server">http</link>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	174 or
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	175 <link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	176 server status information in the specified <value>zone</value>.
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	177 Several servers may share the same zone.
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	178 </para>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	179
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	180 <para id="status_zone_location">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	181 Starting from 1.17.0, status information can be collected
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	182 per <link doc="ngx_http_core_module.xml" id="location"/>.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	183 The special value <literal>off</literal> disables statistics collection
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	184 in nested location blocks.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	185 Note that the statistics is collected
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	186 in the context of a location where processing ends.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	187 It may be different from the original location, if an
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	188 <link doc="ngx_http_core_module.xml" id="internal">internal
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	189 redirect</link> happens during request processing.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	190 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	191
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	192 </directive>
45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	193
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	194 </section>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	195
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	196 <section id="compatibility" name="Compatibility">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	197
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	198 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	199 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	200
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	201 <listitem>
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	202 The <link id="stream_limit_conns_">/stream/limit_conns/</link> data
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	203 were added in <link id="api_version">version</link> 6.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	204 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	205
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	206 <listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	207 The <link id="http_limit_conns_">/http/limit_conns/</link> data
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	208 were added in <link id="api_version">version</link> 6.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	209 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	210
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	211 <listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	212 The <link id="http_limit_reqs_">/http/limit_reqs/</link> data
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	213 were added in <link id="api_version">version</link> 6.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	214 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	215
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	216 <listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	217 The “<literal>expire</literal>” parameter of a
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	218 <link doc="ngx_http_keyval_module.xml">key-value</link> pair can be
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	219 <link id="postHttpKeyvalZoneData">set</link> or
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	220 <link id="patchHttpKeyvalZoneKeyValue">changed</link>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	221 since <link id="api_version">version</link> 5.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	222 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	223
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	224 <listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	225 The <link id="resolvers_">/resolvers/</link> data
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	226 were added in <link id="api_version">version</link> 5.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	227 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	228
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	229 <listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	230 The <link id="http_location_zones_">/http/location_zones/</link> data
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	231 were added in <link id="api_version">version</link> 5.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	232 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	233
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	234 <listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	235 The <literal>path</literal> and <literal>method</literal> fields of
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	236 <link id="def_nginx_error">nginx error object</link>
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	237 were removed in <link id="api_version">version</link> 4.
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	238 These fields continue to exist in earlier api versions,
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	239 but show an empty value.
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	240 </listitem>
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	241
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	242 <listitem>
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	243 The <link id="stream_zone_sync_">/stream/zone_sync/</link> data
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	244 were added in <link id="api_version">version</link> 3.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	245 </listitem>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	246
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	247 <listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	248 The <link id="def_nginx_http_upstream_conf_server">drain</link> parameter
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	249 was added in <link id="api_version">version</link> 2.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	250 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	251
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	252 <listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	253 The <link id="stream_keyvals_">/stream/keyvals/</link> data
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	254 were added in <link id="api_version">version</link> 2.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	255 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	256
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	257 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	258 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	259
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	260 </section>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	261 <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	262 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	263 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	264 <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	265 <literal>/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	266 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	267 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	268 <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	269 <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	270 <listitem id="getAPIEndpoints">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	271 <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	272 <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	273 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	274 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	275 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	276 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	277 <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	278 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	279 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	280 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	281 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	282 <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	283 <literal>/nginx</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	284 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	285 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	286 <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	287 <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	288 <listitem id="getNginx">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	289 <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	290 <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	291 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	292 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	293 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	294 <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	295 (<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	296 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	297 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	298 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	299 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	300 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	301 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	302 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	303 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	304 <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	305 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	306 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	307 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	308 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	309 <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	310 <literal>/processes</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	311 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	312 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	313 <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	314 <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	315 <listitem id="getProcesses">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	316 <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	317 <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	318 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	319 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	320 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	321 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	322 <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	323 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	324 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	325 <listitem id="deleteProcesses">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	326 <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	327 <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	328 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	329 Possible responses:
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 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	332 <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	333 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	334 </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 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	337 <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	338 <literal>/connections</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	339 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	340 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	341 <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	342 <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	343 <listitem id="getConnections">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	344 <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	345 <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	346 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	347 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	348 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	349 <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	350 (<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	351 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	352 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	353 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	354 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	355 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	356 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	357 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	358 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	359 <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	360 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	361 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	362 <listitem id="deleteConnections">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	363 <literal>DELETE</literal> - Reset client connections statistics
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	364 <para>Resets 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	365 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	366 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	367 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	368 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	369 <listitem>204 - Success</listitem>
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 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	373 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	374 <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	375 <literal>/slabs/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	376 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	377 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	378 <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	379 <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	380 <listitem id="getSlabs">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	381 <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	382 <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	383 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	384 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	385 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	386 <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	387 (<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	388 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	389 Limits which fields of slab zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	390 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	391 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	392 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	393 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	394 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	395 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	396 <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>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	397 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	398 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	399 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	400 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	401 <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	402 <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	403 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	404 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	405 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	406 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	407 <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	408 (<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	409 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	410 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	411 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	412 <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	413 <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	414 <listitem id="getSlabZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	415 <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	416 <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	417 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	418 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	419 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	420 <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	421 (<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	422 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	423 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	424 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	425 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	426 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	427 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	428 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	429 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	430 <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	431 <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	432 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	433 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	434 <listitem id="deleteSlabZoneStats">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	435 <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	436 <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	437 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	438 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	439 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	440 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	441 <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	442 <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	443 <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	444 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	445 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	446 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	447 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	448 <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	449 <literal>/http/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	450 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	451 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	452 <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	453 <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	454 <listitem id="getHttp">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	455 <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	456 <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	457 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	458 Possible responses:
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 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	461 <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	462 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	463 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	464 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	465 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	466 <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	467 <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	468 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	469 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	470 <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	471 <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	472 <listitem id="getHttpRequests">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	473 <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	474 <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	475 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	476 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	477 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	478 <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	479 (<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	480 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	481 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	482 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	483 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	484 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	485 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	486 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	487 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	488 <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	489 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	490 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	491 <listitem id="deleteHttpRequests">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	492 <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	493 <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	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>204 - Success</listitem>
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	499 <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	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 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	503 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	504 <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	505 <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	506 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	507 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	508 <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	509 <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	510 <listitem id="getHttpServerZones">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	511 <literal>GET</literal> - Return status of all HTTP server zones
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	512 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">server zone</link>.</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	513 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	514 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	515 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	516 <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	517 (<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	518 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	519 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	520 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	521 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	522 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	523 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	524 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	525 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	526 <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>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	527 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	528 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	529 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	530 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	531 <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	532 <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	533 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	534 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	535 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	536 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	537 <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	538 (<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	539 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	540 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	541 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	542 <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	543 <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	544 <listitem id="getHttpServerZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	545 <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	546 <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	547 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	548 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	549 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	550 <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	551 (<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	552 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	553 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	554 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	555 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	556 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	557 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	558 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	559 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	560 <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	561 <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	562 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	563 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	564 <listitem id="deleteHttpServerZoneStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	565 <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	566 <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	567 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	568 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	569 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	570 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	571 <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	572 <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	573 <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	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 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	577 </tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	578 <tag-name id="http_location_zones_" name="/http/location_zones/">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	579 <literal>/http/location_zones/</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	580 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	581 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	582 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	583 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	584 <listitem id="getHttpLocationZones">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	585 <literal>GET</literal> - Return status of all HTTP location zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	586 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	587 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	588 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	589 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	590 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	591 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	592 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	593 Limits which fields of location zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	594 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	595 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	596 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	597 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	598 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	599 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	600 <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>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	601 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	602 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	603 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	604 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	605 <tag-name id="http_location_zones_http_location_zone_name" name="/http/location_zones/{httpLocationZoneName}">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	606 <literal>/http/location_zones/{httpLocationZoneName}</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	607 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	608 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	609 Parameters common for all methods:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	610 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	611 <tag-name><literal>httpLocationZoneName</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	612 (<literal>string</literal>, required)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	613 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	614 The name of an HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	615 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	616 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	617 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	618 <listitem id="getHttpLocationZone">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	619 <literal>GET</literal> - Return status of an HTTP location zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	620 <para>Returns status of a particular HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	621 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	622 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	623 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	624 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	625 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	626 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	627 Limits which fields of the location zone will be output.</tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	628 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	629 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	630 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	631 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	632 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	633 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	634 <listitem>200 - Success, returns <link id="def_nginx_http_location_zone">HTTP Location Zone</link></listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	635 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	636 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	637 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	638 <listitem id="deleteHttpLocationZoneStat">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	639 <literal>DELETE</literal> - Reset statistics for a location zone.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	640 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular location zone.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	641 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	642 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	643 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	644 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	645 <listitem>204 - Success</listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	646 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	647 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	648 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	649 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	650 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	651 </tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	652 <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	653 <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	654 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	655 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	656 <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	657 <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	658 <listitem id="getHttpCaches">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	659 <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	660 <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	661 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	662 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	663 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	664 <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	665 (<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	666 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	667 Limits which fields of cache zones will be output. If the “<literal>fields</literal>” value is empty, then only names of cache zones will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	668 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	669 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	670 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	671 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	672 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	673 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	674 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_cache">HTTP Cache</link>" objects for all HTTP caches</listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	675 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	676 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	677 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	678 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	679 <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	680 <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	681 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	682 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	683 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	684 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	685 <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	686 (<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	687 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	688 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	689 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	690 <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	691 <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	692 <listitem id="getHttpCacheZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	693 <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	694 <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	695 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	696 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	697 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	698 <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	699 (<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	700 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	701 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	702 </list>
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 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	705 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	706 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	707 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	708 <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	709 <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	710 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	711 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	712 <listitem id="deleteHttpCacheZoneStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	713 <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	714 <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	715 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	716 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	717 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	718 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	719 <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	720 <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	721 <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	722 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	723 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	724 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	725 </tag-desc>
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	726 <tag-name id="http_limit_conns_" name="/http/limit_conns/">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	727 <literal>/http/limit_conns/</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	728 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	729 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	730 <para>Supported methods:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	731 <list type="bullet" compact="yes">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	732 <listitem id="getHttpLimitConnZones">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	733 <literal>GET</literal> - Return status of all HTTP limit_conn zones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	734 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	735 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	736 Request parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	737 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	738 <tag-name><literal>fields</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	739 (<literal>string</literal>, optional)</tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	740 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	741 Limits which fields of limit_conn zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	742 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	743 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	744 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	745 Possible responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	746 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	747 <list type="bullet">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	748 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link>" objects for all HTTP limit conns</listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	749 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	750 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	751 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	752 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	753 <tag-name id="http_limit_conns_http_limit_conn_zone_name" name="/http/limit_conns/{httpLimitConnZoneName}">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	754 <literal>/http/limit_conns/{httpLimitConnZoneName}</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	755 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	756 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	757 Parameters common for all methods:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	758 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	759 <tag-name><literal>httpLimitConnZoneName</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	760 (<literal>string</literal>, required)</tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	761 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	762 The name of a <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	763 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	764 <para>Supported methods:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	765 <list type="bullet" compact="yes">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	766 <listitem id="getHttpLimitConnZone">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	767 <literal>GET</literal> - Return status of an HTTP limit_conn zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	768 <para>Returns status of a particular HTTP <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	769 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	770 Request parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	771 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	772 <tag-name><literal>fields</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	773 (<literal>string</literal>, optional)</tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	774 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	775 Limits which fields of the <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</link> will be output.</tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	776 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	777 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	778 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	779 Possible responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	780 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	781 <list type="bullet">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	782 <listitem>200 - Success, returns <link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	783 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	784 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	785 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	786 <listitem id="deleteHttpLimitConnZoneStat">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	787 <literal>DELETE</literal> - Reset statistics for an HTTP limit_conn zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	788 <para>Resets the connection limiting statistics.</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	789 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	790 Possible responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	791 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	792 <list type="bullet">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	793 <listitem>204 - Success</listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	794 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	795 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	796 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	797 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	798 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	799 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	800 <tag-name id="http_limit_reqs_" name="/http/limit_reqs/">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	801 <literal>/http/limit_reqs/</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	802 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	803 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	804 <para>Supported methods:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	805 <list type="bullet" compact="yes">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	806 <listitem id="getHttpLimitReqZones">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	807 <literal>GET</literal> - Return status of all HTTP limit_req zones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	808 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</link>.</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	809 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	810 Request parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	811 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	812 <tag-name><literal>fields</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	813 (<literal>string</literal>, optional)</tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	814 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	815 Limits which fields of limit_req zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	816 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	817 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	818 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	819 Possible responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	820 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	821 <list type="bullet">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	822 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link>" objects for all HTTP limit reqs</listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	823 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	824 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	825 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	826 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	827 <tag-name id="http_limit_reqs_http_limit_req_zone_name" name="/http/limit_reqs/{httpLimitReqZoneName}">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	828 <literal>/http/limit_reqs/{httpLimitReqZoneName}</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	829 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	830 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	831 Parameters common for all methods:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	832 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	833 <tag-name><literal>httpLimitReqZoneName</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	834 (<literal>string</literal>, required)</tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	835 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	836 The name of a <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</link>.</tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	837 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	838 <para>Supported methods:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	839 <list type="bullet" compact="yes">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	840 <listitem id="getHttpLimitReqZone">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	841 <literal>GET</literal> - Return status of an HTTP limit_req zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	842 <para>Returns status of a particular HTTP <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</link>.</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	843 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	844 Request parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	845 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	846 <tag-name><literal>fields</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	847 (<literal>string</literal>, optional)</tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	848 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	849 Limits which fields of the <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</link> will be output.</tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	850 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	851 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	852 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	853 Possible responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	854 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	855 <list type="bullet">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	856 <listitem>200 - Success, returns <link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	857 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	858 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	859 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	860 <listitem id="deleteHttpLimitReqZoneStat">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	861 <literal>DELETE</literal> - Reset statistics for an HTTP limit_req zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	862 <para>Resets the requests limiting statistics.</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	863 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	864 Possible responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	865 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	866 <list type="bullet">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	867 <listitem>204 - Success</listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	868 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	869 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	870 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	871 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	872 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	873 </tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	874 <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	875 <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	876 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	877 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	878 <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	879 <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	880 <listitem id="getHttpUpstreams">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	881 <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	882 <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	883 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	884 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	885 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	886 <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	887 (<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	888 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	889 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	890 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	891 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	892 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	893 Possible responses:
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 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	896 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_upstream">HTTP Upstream</link>" objects for all HTTP upstreams</listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	897 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	898 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	899 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	900 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	901 <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	902 <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	903 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	904 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	905 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	906 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	907 <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	908 (<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	909 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	910 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	911 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	912 <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	913 <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	914 <listitem id="getHttpUpstreamName">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	915 <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	916 <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	917 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	918 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	919 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	920 <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	921 (<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	922 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	923 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	924 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	925 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	926 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	927 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	928 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	929 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	930 <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	931 <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	932 <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	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="deleteHttpUpstreamStat">
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> - 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	937 <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	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>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	944 <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	945 <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	946 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	947 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	948 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	949 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	950 <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	951 <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	952 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	953 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	954 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	955 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	956 <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	957 (<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	958 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	959 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	960 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	961 <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	962 <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	963 <listitem id="getHttpUpstreamServers">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	964 <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	965 <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	966 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	967 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	968 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	969 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	970 <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	971 <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	972 <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	973 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	974 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	975 <listitem id="postHttpUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	976 <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	977 <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	978 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	979 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	980 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	981 <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	982 (<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	983 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	984 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	985 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	986 </para>
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 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	989 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	990 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	991 <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	992 <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	993 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	994 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	995 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	996 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	997 “<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	998 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	999 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	1000 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	1001 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	1002 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	1003 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	1004 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	1005 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	1006 “<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	1007 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	1008 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	1009 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	1010 <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	1011 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1012 <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	1013 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1014 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1015 </list>
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 <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	1018 <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	1019 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1020 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1021 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	1022 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1023 <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	1024 (<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	1025 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1026 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	1027 <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	1028 (<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	1029 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1030 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	1031 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1032 <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	1033 <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	1034 <listitem id="getHttpUpstreamPeer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1035 <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	1036 <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	1037 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1038 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1039 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1040 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1041 <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	1042 <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	1043 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	1044 <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	1045 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	1046 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1047 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1048 <listitem id="patchHttpUpstreamPeer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1049 <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	1050 <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	1051 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1052 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1053 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1054 <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	1055 (<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	1056 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1057 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	1058 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1059 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1060 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1061 Possible responses:
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 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1064 <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	1065 <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	1066 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	1067 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	1068 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	1069 “<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	1070 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	1071 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	1072 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	1073 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	1074 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	1075 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	1076 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	1077 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	1078 “<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	1079 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	1080 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	1081 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	1082 <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	1083 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	1084 <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	1085 <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	1086 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1087 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1088 <listitem id="deleteHttpUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1089 <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	1090 <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	1091 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1092 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1093 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1094 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1095 <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	1096 <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	1097 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	1098 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	1099 <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	1100 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	1101 <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	1102 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1103 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1104 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1105 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1106 <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	1107 <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	1108 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1109 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1110 <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	1111 <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	1112 <listitem id="getHttpKeyvalZones">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1113 <literal>GET</literal> - Return key-value pairs from all HTTP keyval zones
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1114 <para>Returns key-value pairs for each HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>.</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1115 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1116 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1117 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1118 <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	1119 (<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	1120 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1121 If the “<literal>fields</literal>” value is empty, then only HTTP keyval zone names will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1122 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1123 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1124 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1125 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1126 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1127 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1128 <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>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1129 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1130 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1131 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1132 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1133 <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	1134 <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	1135 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1136 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1137 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	1138 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1139 <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	1140 (<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	1141 <tag-desc>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1142 The name of an HTTP keyval shared memory zone.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1143 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1144 <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	1145 <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	1146 <listitem id="getHttpKeyvalZoneKeysValues">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1147 <literal>GET</literal> - Return key-value pairs from an HTTP keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1148 <para>Returns key-value pairs stored in a particular HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>.</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1149 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1150 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1151 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1152 <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	1153 (<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	1154 <tag-desc>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1155 Get a particular key-value pair from the HTTP keyval zone.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1156 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1157 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1158 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1159 Possible responses:
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 <list type="bullet">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1162 <listitem>200 - Success, returns <link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link></listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1163 <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	1164 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	1165 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1166 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1167 <listitem id="postHttpKeyvalZoneData">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1168 <literal>POST</literal> - Add a key-value pair to the HTTP keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1169 <para>Adds a new key-value pair to the HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty.</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1170 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1171 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1172 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1173 <tag-name><literal>Key-value</literal>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1174 (<link id="def_nginx_http_keyval_zone_post_patch">HTTP Keyval Shared Memory Zone</link>, required)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1175 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1176 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</link> directive.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1177 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1178 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1179 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1180 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1181 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1182 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1183 <listitem>201 - Created</listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1184 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1185 invalid key format (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1186 key required (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1187 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1188 only one key can be added (<literal>KeyvalFormatError</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	1189 <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	1190 <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	1191 <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	1192 <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	1193 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1194 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1195 <listitem id="patchHttpKeyvalZoneKeyValue">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1196 <literal>PATCH</literal> - Modify a key-value or delete a key
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1197 <para>Changes the value of the selected key in the key-value pair, deletes a key by setting the key value to <literal>null</literal>, changes expiration time of a key-value pair. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</link> directive.</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1198 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1199 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1200 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1201 <tag-name><literal>httpKeyvalZoneKeyValue</literal>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1202 (<link id="def_nginx_http_keyval_zone_post_patch">HTTP Keyval Shared Memory Zone</link>, required)</tag-name>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1203 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1204 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	1205 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1206 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1207 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1208 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1209 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1210 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1211 <listitem>204 - Success</listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1212 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1213 key required (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1214 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1215 only one key can be updated (<literal>KeyvalFormatError</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	1216 <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	1217 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	1218 <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	1219 <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	1220 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1221 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1222 <listitem id="deleteHttpKeyvalZoneData">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1223 <literal>DELETE</literal> - Empty the HTTP keyval zone
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1224 <para>Deletes all key-value pairs from the HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, empties the keyval zone only on a target cluster node.</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1225 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1226 Possible responses:
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 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1229 <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	1230 <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	1231 <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	1232 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1233 </listitem>
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 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1236 <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	1237 <literal>/stream/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1238 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1239 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1240 <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	1241 <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	1242 <listitem id="getStream">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1243 <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	1244 <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	1245 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1246 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1247 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1248 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1249 <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	1250 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1251 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1252 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1253 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1254 <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	1255 <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	1256 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1257 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1258 <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	1259 <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	1260 <listitem id="getStreamServerZones">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1261 <literal>GET</literal> - Return status of all stream server zones
2221 45a2b90247ad Added "status_zone" to the API module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2139 diff changeset	1262 <para>Returns status information for each stream <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">server zone</link>.</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1263 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1264 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1265 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1266 <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	1267 (<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	1268 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1269 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1270 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1271 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1272 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1273 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1274 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1275 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1276 <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>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1277 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1278 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1279 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1280 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1281 <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	1282 <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	1283 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1284 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1285 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	1286 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1287 <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	1288 (<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	1289 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1290 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	1291 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1292 <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	1293 <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	1294 <listitem id="getStreamServerZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1295 <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	1296 <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	1297 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1298 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1299 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1300 <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	1301 (<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	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 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	1304 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1305 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1306 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1307 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1308 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1309 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1310 <listitem>200 - Success, returns <link id="def_nginx_stream_server_zone">Stream Server Zone</link></listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1311 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</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	1312 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1313 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1314 <listitem id="deleteStreamServerZoneStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1315 <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	1316 <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	1317 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1318 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1319 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1320 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1321 <listitem>204 - Success</listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1322 <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	1323 <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	1324 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1325 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1326 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1327 </tag-desc>
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1328 <tag-name id="stream_limit_conns_" name="/stream/limit_conns/">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1329 <literal>/stream/limit_conns/</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1330 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1331 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1332 <para>Supported methods:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1333 <list type="bullet" compact="yes">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1334 <listitem id="getStreamLimitConnZones">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1335 <literal>GET</literal> - Return status of all stream limit_conn zones
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1336 <para>Returns status information for each stream <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1337 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1338 Request parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1339 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1340 <tag-name><literal>fields</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1341 (<literal>string</literal>, optional)</tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1342 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1343 Limits which fields of limit_conn zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1344 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1345 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1346 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1347 Possible responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1348 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1349 <list type="bullet">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1350 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link>" objects for all stream limit conns</listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1351 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1352 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1353 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1354 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1355 <tag-name id="stream_limit_conns_stream_limit_conn_zone_name" name="/stream/limit_conns/{streamLimitConnZoneName}">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1356 <literal>/stream/limit_conns/{streamLimitConnZoneName}</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1357 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1358 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1359 Parameters common for all methods:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1360 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1361 <tag-name><literal>streamLimitConnZoneName</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1362 (<literal>string</literal>, required)</tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1363 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1364 The name of a <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1365 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1366 <para>Supported methods:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1367 <list type="bullet" compact="yes">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1368 <listitem id="getStreamLimitConnZone">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1369 <literal>GET</literal> - Return status of an stream limit_conn zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1370 <para>Returns status of a particular stream <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</link>.</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1371 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1372 Request parameters:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1373 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1374 <tag-name><literal>fields</literal>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1375 (<literal>string</literal>, optional)</tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1376 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1377 Limits which fields of the <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</link> will be output.</tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1378 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1379 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1380 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1381 Possible responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1382 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1383 <list type="bullet">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1384 <listitem>200 - Success, returns <link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1385 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1386 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1387 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1388 <listitem id="deleteStreamLimitConnZoneStat">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1389 <literal>DELETE</literal> - Reset statistics for a stream limit_conn zone
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1390 <para>Resets the connection limiting statistics.</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1391 <para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1392 Possible responses:
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1393 </para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1394 <list type="bullet">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1395 <listitem>204 - Success</listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1396 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1397 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1398 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1399 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1400 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	1401 </tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1402 <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	1403 <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	1404 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1405 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1406 <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	1407 <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	1408 <listitem id="getStreamUpstreams">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1409 <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	1410 <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	1411 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1412 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1413 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1414 <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	1415 (<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	1416 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1417 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1418 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1419 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1420 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1421 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1422 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1423 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1424 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams</listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1425 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1426 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1427 </list>
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 <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	1430 <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	1431 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1432 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1433 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	1434 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1435 <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	1436 (<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	1437 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1438 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	1439 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1440 <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	1441 <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	1442 <listitem id="getStreamUpstream">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1443 <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	1444 <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	1445 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1446 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1447 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1448 <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	1449 (<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	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 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	1452 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1453 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1454 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1455 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1456 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1457 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1458 <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	1459 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1460 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1461 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1462 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1463 <listitem id="deleteStreamUpstreamStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1464 <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	1465 <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	1466 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1467 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1468 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1469 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1470 <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	1471 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1472 <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	1473 <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	1474 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1475 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1476 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1477 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1478 <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	1479 <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	1480 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1481 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1482 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	1483 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1484 <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	1485 (<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	1486 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1487 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	1488 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1489 <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	1490 <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	1491 <listitem id="getStreamUpstreamServers">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1492 <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	1493 <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	1494 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1495 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1496 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1497 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1498 <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	1499 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1500 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1501 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1502 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1503 <listitem id="postStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1504 <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	1505 <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	1506 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1507 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1508 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1509 <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	1510 (<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	1511 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1512 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	1513 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1514 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1515 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1516 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1517 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1518 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1519 <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	1520 <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	1521 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	1522 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	1523 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	1524 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	1525 “<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	1526 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	1527 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	1528 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	1529 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	1530 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	1531 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	1532 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	1533 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	1534 “<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	1535 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	1536 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	1537 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1538 <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	1539 <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	1540 <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	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 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1544 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1545 <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	1546 <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	1547 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1548 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1549 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	1550 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1551 <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	1552 (<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	1553 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1554 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	1555 <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	1556 (<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	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 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	1559 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1560 <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	1561 <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	1562 <listitem id="getStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1563 <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	1564 <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	1565 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1566 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1567 </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="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1569 <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	1570 <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	1571 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	1572 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1573 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1574 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1575 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1576 <listitem id="patchStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1577 <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	1578 <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	1579 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1580 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1581 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1582 <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	1583 (<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	1584 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1585 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	1586 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1587 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1588 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1589 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1590 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1591 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1592 <listitem>200 - Success, returns <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	1593 <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	1594 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	1595 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	1596 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	1597 “<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	1598 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	1599 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	1600 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	1601 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	1602 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	1603 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	1604 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	1605 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	1606 “<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	1607 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	1608 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	1609 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	1610 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1611 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	1612 <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	1613 <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	1614 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1615 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1616 <listitem id="deleteStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1617 <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	1618 <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	1619 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1620 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1621 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1622 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1623 <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	1624 <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	1625 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	1626 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	1627 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1628 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	1629 <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	1630 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1631 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1632 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1633 </tag-desc>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1634 <tag-name id="stream_keyvals_" name="/stream/keyvals/">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1635 <literal>/stream/keyvals/</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1636 </tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1637 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1638 <para>Supported methods:</para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1639 <list type="bullet" compact="yes">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1640 <listitem id="getStreamKeyvalZones">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1641 <literal>GET</literal> - Return key-value pairs from all stream keyval zones
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1642 <para>Returns key-value pairs for each stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>.</para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1643 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1644 Request parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1645 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1646 <tag-name><literal>fields</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1647 (<literal>string</literal>, optional)</tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1648 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1649 If the “<literal>fields</literal>” value is empty, then only stream keyval zone names will be output.</tag-desc>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1650 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1651 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1652 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1653 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1654 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1655 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1656 <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>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1657 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1658 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1659 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1660 </tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1661 <tag-name id="stream_keyvals_stream_keyval_zone_name" name="/stream/keyvals/{streamKeyvalZoneName}">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1662 <literal>/stream/keyvals/{streamKeyvalZoneName}</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1663 </tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1664 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1665 Parameters common for all methods:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1666 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1667 <tag-name><literal>streamKeyvalZoneName</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1668 (<literal>string</literal>, required)</tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1669 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1670 The name of a stream keyval shared memory zone.</tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1671 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1672 <para>Supported methods:</para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1673 <list type="bullet" compact="yes">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1674 <listitem id="getStreamKeyvalZoneKeysValues">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1675 <literal>GET</literal> - Return key-value pairs from a stream keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1676 <para>Returns key-value pairs stored in a particular stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>.</para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1677 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1678 Request parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1679 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1680 <tag-name><literal>key</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1681 (<literal>string</literal>, optional)</tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1682 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1683 Get a particular key-value pair from the stream keyval zone.</tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1684 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1685 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1686 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1687 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1688 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1689 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1690 <listitem>200 - Success, returns <link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link></listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1691 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1692 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1693 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1694 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1695 <listitem id="postStreamKeyvalZoneData">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1696 <literal>POST</literal> - Add a key-value pair to the stream keyval zone
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1697 <para>Adds a new key-value pair to the stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the stream keyval shared memory zone is empty.</para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1698 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1699 Request parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1700 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1701 <tag-name><literal>Key-value</literal>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1702 (<link id="def_nginx_stream_keyval_zone_post_patch">Stream Keyval Shared Memory Zone</link>, required)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1703 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1704 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the stream keyval shared memory zone is empty. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</link> directive.</tag-desc>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1705 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1706 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1707 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1708 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1709 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1710 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1711 <listitem>201 - Created</listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1712 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1713 invalid key format (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1714 key required (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1715 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1716 only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1717 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1718 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1719 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1720 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1721 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1722 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1723 <listitem id="patchStreamKeyvalZoneKeyValue">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1724 <literal>PATCH</literal> - Modify a key-value or delete a key
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1725 <para>Changes the value of the selected key in the key-value pair, deletes a key by setting the key value to <literal>null</literal>, changes expiration time of a key-value pair. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node. Expiration time is specified in milliseconds with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</link> directive.</para>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1726 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1727 Request parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1728 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1729 <tag-name><literal>streamKeyvalZoneKeyValue</literal>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1730 (<link id="def_nginx_stream_keyval_zone_post_patch">Stream Keyval Shared Memory Zone</link>, required)</tag-name>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1731 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1732 A new value for the key is specified in the JSON format.</tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1733 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1734 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1735 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1736 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1737 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1738 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1739 <listitem>204 - Success</listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1740 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1741 key required (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1742 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1743 only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1744 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1745 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1746 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1747 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1748 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1749 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1750 <listitem id="deleteStreamKeyvalZoneData">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1751 <literal>DELETE</literal> - Empty the stream keyval zone
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1752 <para>Deletes all key-value pairs from the stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, empties the keyval zone only on a target cluster node.</para>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1753 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1754 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1755 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1756 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1757 <listitem>204 - Success</listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1758 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1759 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1760 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1761 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1762 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1763 </tag-desc>
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1764 <tag-name id="stream_zone_sync_" name="/stream/zone_sync/">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1765 <literal>/stream/zone_sync/</literal>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1766 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1767 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1768 <para>Supported methods:</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1769 <list type="bullet" compact="yes">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1770 <listitem id="getStreamZoneSync">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1771 <literal>GET</literal> - Return sync status of a node
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1772 <para>Returns synchronization status of a cluster node.</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1773 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1774 Possible responses:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1775 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1776 <list type="bullet">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1777 <listitem>200 - Success, returns <link id="def_nginx_stream_zone_sync">Stream Zone Sync Node</link></listitem>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1778 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1779 </listitem>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1780 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1781 </tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1782 <tag-name id="resolvers_" name="/resolvers/">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1783 <literal>/resolvers/</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1784 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1785 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1786 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1787 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1788 <listitem id="getResolverZones">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1789 <literal>GET</literal> - Return status for all resolver zones
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1790 <para>Returns status information for each <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</link>.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1791 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1792 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1793 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1794 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1795 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1796 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1797 Limits which fields of resolvers statistics will be output.</tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1798 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1799 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1800 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1801 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1802 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1803 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1804 <listitem>200 - Success, returns a collection of "<link id="def_nginx_resolver_zone">Resolver Zone</link>" objects for all resolvers</listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1805 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1806 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1807 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1808 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1809 <tag-name id="resolvers_resolver_zone_name" name="/resolvers/{resolverZoneName}">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1810 <literal>/resolvers/{resolverZoneName}</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1811 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1812 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1813 Parameters common for all methods:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1814 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1815 <tag-name><literal>resolverZoneName</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1816 (<literal>string</literal>, required)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1817 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1818 The name of a resolver zone.</tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1819 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1820 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1821 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1822 <listitem id="getResolverZone">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1823 <literal>GET</literal> - Return statistics of a resolver zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1824 <para>Returns statistics stored in a particular resolver <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">zone</link>.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1825 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1826 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1827 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1828 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1829 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1830 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1831 Limits which fields of the resolver zone will be output (requests, responses, or both).</tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1832 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1833 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1834 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1835 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1836 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1837 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1838 <listitem>200 - Success, returns <link id="def_nginx_resolver_zone">Resolver Zone</link></listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1839 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1840 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1841 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1842 <listitem id="deleteResolverZoneStat">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1843 <literal>DELETE</literal> - Reset statistics for a resolver zone.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1844 <para>Resets statistics in a particular resolver zone.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1845 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1846 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1847 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1848 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1849 <listitem>204 - Success</listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1850 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1851 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1852 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1853 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1854 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1855 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1856 <tag-name id="ssl" name="/ssl">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1857 <literal>/ssl</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1858 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1859 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1860 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1861 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1862 <listitem id="getSsl">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1863 <literal>GET</literal> - Return SSL statistics
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1864 <para>Returns SSL statistics.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1865 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1866 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1867 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1868 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1869 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1870 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1871 Limits which fields of SSL statistics will be output.</tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1872 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1873 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1874 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1875 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1876 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1877 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1878 <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1879 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1880 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1881 <listitem id="deleteSslStat">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1882 <literal>DELETE</literal> - Reset SSL statistics
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1883 <para>Resets counters of SSL handshakes and session reuses.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1884 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1885 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1886 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1887 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1888 <listitem>204 - Success</listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1889 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1890 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1891 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1892 </tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1893 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1894 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1895 </section>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1896 <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	1897 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1898 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1899 <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	1900 <para>nginx:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1901 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	1902 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1903 <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	1904 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1905 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1906 Version of nginx.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1907 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1908 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1909 <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	1910 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1911 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1912 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	1913 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1914 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1915 <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	1916 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1917 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1918 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	1919 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1920 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1921 <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	1922 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1923 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1924 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	1925 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1926 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1927 <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	1928 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1929 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1930 Time of the last reload of configuration, in the ISO 8601 format with millisecond resolution.
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1931 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1932 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1933 <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	1934 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1935 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1936 Current time in the ISO 8601 format with millisecond resolution.
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1937 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1938 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1939 <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	1940 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1941 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1942 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	1943 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1944 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1945 <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	1946 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1947 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1948 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	1949 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1950 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1951 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1952 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1953 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1954 "nginx" : {
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1955 "version" : "1.17.3",
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1956 "build" : "nginx-plus-r19",
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1957 "address" : "206.251.255.64",
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1958 "generation" : 6,
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1959 "load_timestamp" : "2019-10-01T11:15:44.467Z",
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	1960 "timestamp" : "2019-10-01T09:26:07.305Z",
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1961 "pid" : 32212,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1962 "ppid" : 32210
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1963 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1964 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1965 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1966 <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	1967 <para>Processes:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1968 <list type="tag">
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 <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	1971 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1972 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1973 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	1974 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1975 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1976 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1977 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1978 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1979 "respawned" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1980 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1981 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1982 <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	1983 <para>Connections:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1984 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	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>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	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 accepted client connections.
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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1992 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1995 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1998 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2001 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2004 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2007 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	2008 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2009 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2010 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2011 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2012 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2013 "accepted" : 4968119,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2014 "dropped" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2015 "active" : 5,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2016 "idle" : 117
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2017 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2018 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2019 <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	2020 <para>SSL:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2021 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2022 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2023 <literal>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	2024 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2025 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2026 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	2027 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2028 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2029 <literal>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	2030 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2031 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2032 The 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	2033 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2034 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2035 <literal>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	2036 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2037 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2038 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	2039 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2040 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2041 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2042 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2043 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2044 "handshakes" : 79572,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2045 "handshakes_failed" : 21025,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2046 "session_reuses" : 15762
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2047 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2048 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2049 <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	2050 <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	2051 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2052 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2053 <literal>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	2054 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2055 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	2056 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2057 <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	2058 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2059 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2060 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	2061 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2062 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2063 <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	2064 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2065 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2066 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	2067 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2068 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2069 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2070 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2071 <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	2072 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2073 <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	2074 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2075 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2076 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2077 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2078 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2079 "pages" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2080 "used" : 1143,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2081 "free" : 2928
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2082 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2083 "slots" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2084 "8" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2085 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2086 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2087 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2088 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2089 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2090 "16" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2091 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2092 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2093 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2094 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2095 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2096 "32" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2097 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2098 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2099 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2100 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2101 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2102 "64" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2103 "used" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2104 "free" : 63,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2105 "reqs" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2106 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2107 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2108 "128" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2109 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2110 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2111 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2112 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2113 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2114 "256" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2115 "used" : 18078,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2116 "free" : 178,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2117 "reqs" : 1635736,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2118 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2119 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2120 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2121 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2122 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2123 <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	2124 <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	2125 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2126 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2127 <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	2128 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2129 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2130 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	2131 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2132 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2133 <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	2134 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2135 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2136 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	2137 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2138 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2139 <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	2140 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2141 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2142 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	2143 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2144 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2145 <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	2146 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2147 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2148 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	2149 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2150 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2151 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2152 <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	2153 <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	2154 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2155 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2156 <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	2157 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2158 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2159 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	2160 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2161 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2162 <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	2163 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2164 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2165 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	2166 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2167 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2168 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2169 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2170 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2171 "total" : 10624511,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2172 "current" : 4
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2173 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2174 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2175 <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	2176 <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	2177 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2178 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2179 <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	2180 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2181 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2182 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	2183 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2184 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2185 <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	2186 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2187 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2188 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	2189 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2190 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2191 <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	2192 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2193 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	2194 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2195 <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	2196 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2197 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2198 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	2199 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2200 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2201 <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	2202 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2203 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2204 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	2205 </tag-desc>
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 <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	2208 </tag-name>
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 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	2211 </tag-desc>
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 <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	2214 </tag-name>
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 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	2217 </tag-desc>
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 <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	2220 </tag-name>
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 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	2223 </tag-desc>
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 <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	2226 </tag-name>
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 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	2229 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2230 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2231 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2232 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2233 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2236 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	2237 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2238 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2239 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2242 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	2243 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2244 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2245 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2248 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	2249 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2250 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2251 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2252 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2253 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2254 "processing" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2255 "requests" : 706690,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2256 "responses" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2257 "1xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2258 "2xx" : 699482,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2259 "3xx" : 4522,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2260 "4xx" : 907,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2261 "5xx" : 266,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2262 "total" : 705177
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2263 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2264 "discarded" : 1513,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2265 "received" : 172711587,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2266 "sent" : 19415530115
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2267 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2268 </listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2269 <listitem id="def_nginx_http_location_zone">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2270 <para>HTTP Location Zone:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2271 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2272 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2273 <literal>requests</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2274 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2275 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2276 The total number of client requests received from clients.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2277 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2278 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2279 <literal>responses</literal></tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2280 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2281 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">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2282 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2283 <literal>1xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2284 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2285 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2286 The number of responses with “<literal>1xx</literal>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2287 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2288 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2289 <literal>2xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2290 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2291 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2292 The number of responses with “<literal>2xx</literal>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2293 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2294 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2295 <literal>3xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2296 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2297 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2298 The number of responses with “<literal>3xx</literal>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2299 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2300 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2301 <literal>4xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2302 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2303 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2304 The number of responses with “<literal>4xx</literal>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2305 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2306 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2307 <literal>5xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2308 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2309 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2310 The number of responses with “<literal>5xx</literal>” status codes.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2311 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2312 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2313 <literal>total</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2314 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2315 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2316 The total number of responses sent to clients.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2317 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2318 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2319 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2320 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2321 <literal>discarded</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2322 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2323 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2324 The total number of requests completed without sending a response.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2325 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2326 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2327 <literal>received</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2328 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2329 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2330 The total number of bytes received from clients.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2331 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2332 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2333 <literal>sent</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2334 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2335 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2336 The total number of bytes sent to clients.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2337 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2338 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2339 <para>Example:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2340 <example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2341 {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2342 "requests" : 706690,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2343 "responses" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2344 "1xx" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2345 "2xx" : 699482,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2346 "3xx" : 4522,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2347 "4xx" : 907,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2348 "5xx" : 266,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2349 "total" : 705177
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2350 },
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2351 "discarded" : 1513,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2352 "received" : 172711587,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2353 "sent" : 19415530115
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2354 }</example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2355 </listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2356 <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	2357 <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	2358 <list type="tag">
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>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	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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2363 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	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>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	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>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2369 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	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>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	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>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2375 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2378 <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	2379 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2380 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2381 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2382 <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	2383 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2384 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2385 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	2386 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2387 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2388 <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	2389 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2390 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2391 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	2392 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2393 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2394 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2395 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2396 <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	2397 <tag-desc>
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>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	2401 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2402 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2403 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	2404 </tag-desc>
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 <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	2407 </tag-name>
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 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	2410 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2411 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2412 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2413 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2414 <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	2415 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2416 <list type="tag">
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 <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	2419 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2420 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2421 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	2422 </tag-desc>
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 <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	2425 </tag-name>
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 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	2428 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2429 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2430 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2431 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2432 <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	2433 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2434 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2435 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2436 <literal>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	2437 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2438 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2439 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	2440 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2441 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2442 <literal>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	2443 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2444 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2445 The total number of bytes 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	2446 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2447 </list>
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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2450 <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	2451 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2452 <list type="tag">
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 <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	2455 </tag-name>
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 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	2458 </tag-desc>
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 <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	2461 </tag-name>
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 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	2464 </tag-desc>
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 <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	2467 </tag-name>
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 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	2470 </tag-desc>
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 <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	2473 </tag-name>
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 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	2476 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2477 </list>
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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2480 <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	2481 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2482 <list type="tag">
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 <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	2485 </tag-name>
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 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	2488 </tag-desc>
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 <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	2491 </tag-name>
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 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	2494 </tag-desc>
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 <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	2497 </tag-name>
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 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	2500 </tag-desc>
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 <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	2503 </tag-name>
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 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	2506 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2507 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2508 </tag-desc>
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>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	2511 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2512 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2513 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2514 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2517 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2520 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2523 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	2524 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2525 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2526 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2529 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	2530 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2531 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2532 <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	2533 </tag-name>
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 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	2536 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2537 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2538 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2539 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2540 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2541 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2542 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2543 "size" : 530915328,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2544 "max_size" : 536870912,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2545 "cold" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2546 "hit" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2547 "responses" : 254032,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2548 "bytes" : 6685627875
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2549 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2550 "stale" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2551 "responses" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2552 "bytes" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2553 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2554 "updating" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2555 "responses" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2556 "bytes" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2557 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2558 "revalidated" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2559 "responses" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2560 "bytes" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2561 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2562 "miss" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2563 "responses" : 1619201,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2564 "bytes" : 53841943822
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2565 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2566 "expired" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2567 "responses" : 45859,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2568 "bytes" : 1656847080,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2569 "responses_written" : 44992,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2570 "bytes_written" : 1641825173
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2571 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2572 "bypass" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2573 "responses" : 200187,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2574 "bytes" : 5510647548,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2575 "responses_written" : 200173,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2576 "bytes_written" : 44992
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2577 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2578 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2579 </listitem>
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2580 <listitem id="def_nginx_http_limit_conn_zone">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2581 <para>HTTP Connections Limiting:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2582 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2583 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2584 <literal>passed</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2585 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2586 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2587 The total number of connections that were neither limited nor accounted as limited.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2588 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2589 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2590 <literal>rejected</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2591 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2592 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2593 The total number of connections that were rejected.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2594 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2595 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2596 <literal>rejected_dry_run</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2597 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2598 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2599 The total number of connections accounted as rejected in the <link url="https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_dry_run">dry run</link> mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2600 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2601 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2602 <para>Example:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2603 <example>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2604 {
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2605 "passed" : 15,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2606 "rejected" : 0,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2607 "rejected_dry_run" : 2
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2608 }</example>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2609 </listitem>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2610 <listitem id="def_nginx_http_limit_req_zone">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2611 <para>HTTP Requests Rate Limiting:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2612 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2613 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2614 <literal>passed</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2615 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2616 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2617 The total number of requests that were neither limited nor accounted as limited.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2618 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2619 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2620 <literal>delayed</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2621 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2622 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2623 The total number of requests that were delayed.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2624 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2625 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2626 <literal>rejected</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2627 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2628 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2629 The total number of requests that were rejected.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2630 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2631 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2632 <literal>delayed_dry_run</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2633 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2634 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2635 The total number of requests accounted as delayed in the <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</link> mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2636 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2637 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2638 <literal>rejected_dry_run</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2639 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2640 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2641 The total number of requests accounted as rejected in the <link url="https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_dry_run">dry run</link> mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2642 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2643 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2644 <para>Example:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2645 <example>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2646 {
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2647 "passed" : 15,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2648 "delayed" : 4,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2649 "rejected" : 0,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2650 "delayed_dry_run" : 1,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2651 "rejected_dry_run" : 2
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2652 }</example>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	2653 </listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2654 <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	2655 <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	2656 <list type="tag">
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 <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	2659 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2660 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	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>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	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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2665 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	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>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	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 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	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>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	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 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	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>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	2681 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2682 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2683 The 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	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>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	2687 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2688 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2689 A boolean value indicating whether the 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	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>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	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 <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	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>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	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 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2704 <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	2705 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2706 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2707 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	2708 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2709 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2710 <literal>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	2711 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2712 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2713 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	2714 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2715 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2716 <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	2717 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2718 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2719 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	2720 </tag-desc>
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>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	2723 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2724 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2725 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2726 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2729 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2732 <literal>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	2733 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2734 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2735 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	2736 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2737 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2738 <literal>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	2739 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2740 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2741 The 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	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>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	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 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	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>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	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 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	2754 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2755 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2756 <literal>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	2757 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2758 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2759 The total number of 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	2760 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2761 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2762 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2763 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2764 <literal>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	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 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2770 <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	2771 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2772 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2773 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	2774 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2775 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2776 <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	2777 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2778 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2779 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	2780 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2781 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2782 <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	2783 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2784 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2785 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	2786 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2787 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2788 <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	2789 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2790 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2791 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2792 <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	2793 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2794 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2795 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	2796 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2797 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2798 <literal>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	2799 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2800 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2801 The 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	2802 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2803 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2804 <literal>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	2805 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2806 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2807 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	2808 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2809 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2810 <literal>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	2811 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2812 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2813 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	2814 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2815 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2816 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2817 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2818 <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	2819 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2820 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2821 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	2822 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2823 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2824 <literal>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	2825 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2826 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	2827 The time when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”, in the ISO 8601 format with millisecond resolution.
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2828 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2829 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2830 <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	2831 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2832 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	2833 The time when the server was last selected to process a request, in the ISO 8601 format with millisecond resolution.
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2834 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2835 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2836 <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	2837 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2838 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2839 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	2840 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2841 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2842 <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	2843 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2844 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2845 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	2846 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2847 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2848 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2849 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2850 <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	2851 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2852 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2853 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	2854 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2855 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2856 <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	2857 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2858 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2859 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	2860 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2861 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2862 <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	2863 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2864 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2865 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	2866 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2867 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2868 <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	2869 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2870 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	2871 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2872 <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	2873 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2874 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2875 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	2876 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2877 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2878 <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	2879 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2880 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2881 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	2882 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2883 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2884 <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	2885 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2886 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2887 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	2888 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2889 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2890 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2891 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2892 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2893 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2894 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2895 "upstream_backend" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2896 "peers" : [
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2897 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2898 "id" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2899 "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	2900 "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	2901 "backup" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2902 "weight" : 5,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2903 "state" : "up",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2904 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2905 "max_conns" : 20,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2906 "requests" : 667231,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2907 "header_time" : 20,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2908 "response_time" : 36,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2909 "responses" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2910 "1xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2911 "2xx" : 666310,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2912 "3xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2913 "4xx" : 915,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2914 "5xx" : 6,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2915 "total" : 667231
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2916 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2917 "sent" : 251946292,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2918 "received" : 19222475454,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2919 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2920 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2921 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2922 "checks" : 26214,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2923 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2924 "unhealthy" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2925 "last_passed" : true
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2926 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2927 "downtime" : 0,
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2928 "downstart" : "2019-10-01T11:09:21.602Z",
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2929 "selected" : "2019-10-01T15:01:25.000Z"
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2930 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2931 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2932 "id" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2933 "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	2934 "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	2935 "backup" : true,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2936 "weight" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2937 "state" : "unhealthy",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2938 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2939 "max_conns" : 20,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2940 "requests" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2941 "responses" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2942 "1xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2943 "2xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2944 "3xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2945 "4xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2946 "5xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2947 "total" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2948 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2949 "sent" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2950 "received" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2951 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2952 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2953 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2954 "checks" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2955 "fails" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2956 "unhealthy" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2957 "last_passed" : false
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2958 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2959 "downtime" : 262925617,
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2960 "downstart" : "2019-10-01T11:09:21.602Z",
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	2961 "selected" : "2019-10-01T15:01:25.000Z"
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2962 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2963 ],
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2964 "keepalive" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2965 "zombies" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2966 "zone" : "upstream_backend"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2967 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2968 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2969 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2970 <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	2971 <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	2972 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	2973 <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	2974 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2975 <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	2976 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2977 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2978 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	2979 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2980 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2981 <literal>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	2982 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2983 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2984 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	2985 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2986 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2987 <literal>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	2988 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2989 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2990 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	2991 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2992 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2993 <literal>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	2994 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2995 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2996 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	2997 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2998 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2999 <literal>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	3000 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3001 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3002 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	3003 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3004 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3005 <literal>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	3006 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3007 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3008 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	3009 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3010 <tag-name>
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3011 <literal>fail_timeout</literal> (<literal>string</literal>)
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3012 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3013 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3014 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	3015 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3016 <tag-name>
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3017 <literal>slow_start</literal> (<literal>string</literal>)
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3018 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3019 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3020 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	3021 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3022 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3023 <literal>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	3024 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3025 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3026 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	3027 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3028 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3029 <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	3030 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3031 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3032 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	3033 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3034 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3035 <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	3036 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3037 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3038 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	3039 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3040 <tag-name>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3041 <literal>drain</literal> (<literal>boolean</literal>)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3042 </tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3043 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3044 Same as the <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#drain">drain</link> parameter of the HTTP upstream server.
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3045 </tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3046 <tag-name>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3047 <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	3048 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3049 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3050 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	3051 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3052 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3053 <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	3054 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3055 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3056 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	3057 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3058 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3059 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3060 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3061 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3062 "id" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3063 "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	3064 "weight" : 4,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3065 "max_conns" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3066 "max_fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3067 "fail_timeout" : "10s",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3068 "slow_start" : "10s",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3069 "route" : "",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3070 "backup" : true,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3071 "down" : true
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3072 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3073 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3074 <listitem id="def_nginx_http_keyval_zone">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3075 <para>HTTP Keyval Shared Memory Zone:</para>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3076 Contents of an HTTP keyval shared memory zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3077 when using the GET method.<para>Example:</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3078 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3079 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3080 "key1" : "value1",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3081 "key2" : "value2",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3082 "key3" : "value3"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3083 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3084 </listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3085 <listitem id="def_nginx_http_keyval_zone_post_patch">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3086 <para>HTTP Keyval Shared Memory Zone:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3087 Contents of an HTTP keyval shared memory zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3088 when using the POST or PATCH methods.<para>Example:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3089 <example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3090 {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3091 "key1" : "value1",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3092 "key2" : "value2",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3093 "key3" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3094 "value" : "value3",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3095 "expire" : 30000
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3096 }
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3097 }</example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3098 </listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3099 <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	3100 <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	3101 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3102 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3103 <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	3104 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3105 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3106 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	3107 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3108 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3109 <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	3110 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3111 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3112 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	3113 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3114 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3115 <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	3116 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3117 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	3118 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3119 <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	3120 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3121 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3122 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	3123 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3124 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3125 <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	3126 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3127 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3128 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	3129 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3130 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3131 <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	3132 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3133 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3134 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	3135 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3136 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3137 <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	3138 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3139 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3140 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	3141 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3142 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3143 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3144 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3145 <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	3146 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3147 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3148 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	3149 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3150 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3151 <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	3152 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3153 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3154 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	3155 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3156 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3157 <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	3158 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3159 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3160 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	3161 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3162 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3163 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3164 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3165 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3166 "dns" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3167 "processing" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3168 "connections" : 155569,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3169 "sessions" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3170 "2xx" : 155564,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3171 "4xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3172 "5xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3173 "total" : 155569
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3174 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3175 "discarded" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3176 "received" : 4200363,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3177 "sent" : 20489184
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3178 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3179 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3180 </listitem>
2469 98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3181 <listitem id="def_nginx_stream_limit_conn_zone">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3182 <para>Stream Connections Limiting:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3183 <list type="tag">
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3184 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3185 <literal>passed</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3186 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3187 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3188 The total number of connections that were neither limited nor accounted as limited.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3189 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3190 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3191 <literal>rejected</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3192 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3193 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3194 The total number of connections that were rejected.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3195 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3196 <tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3197 <literal>rejected_dry_run</literal> (<literal>integer</literal>)
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3198 </tag-name>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3199 <tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3200 The total number of connections accounted as rejected in the <link url="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_dry_run">dry run</link> mode.
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3201 </tag-desc>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3202 </list>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3203 <para>Example:</para>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3204 <example>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3205 {
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3206 "passed" : 15,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3207 "rejected" : 0,
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3208 "rejected_dry_run" : 2
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3209 }</example>
98fd810c13e0 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2439 diff changeset	3210 </listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3211 <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	3212 <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	3213 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3214 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3215 <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	3216 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3217 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	3218 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3219 <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	3220 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3221 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3222 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	3223 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3224 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3225 <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	3226 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3227 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3228 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	3229 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3230 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3231 <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	3232 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3233 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3234 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	3235 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3236 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3237 <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	3238 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3239 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3240 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	3241 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3242 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3243 <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	3244 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3245 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3246 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	3247 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3248 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3249 <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	3250 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3251 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3252 <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	3253 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3254 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3255 <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	3256 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3257 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3258 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	3259 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3260 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3261 <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	3262 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3263 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3264 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	3265 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3266 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3267 <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	3268 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3269 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3270 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	3271 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3272 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3273 <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	3274 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3275 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3276 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	3277 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3278 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3279 <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	3280 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3281 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3282 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	3283 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3284 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3285 <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	3286 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3287 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3288 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	3289 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3290 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3291 <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	3292 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3293 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3294 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	3295 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3296 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3297 <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	3298 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3299 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3300 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	3301 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3302 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3303 <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	3304 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3305 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3306 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	3307 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3308 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3309 <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	3310 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3311 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3312 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	3313 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3314 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3315 <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	3316 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3317 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3318 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	3319 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3320 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3321 <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	3322 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3323 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3324 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3325 <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	3326 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3327 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3328 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	3329 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3330 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3331 <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	3332 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3333 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3334 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	3335 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3336 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3337 <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	3338 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3339 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3340 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	3341 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3342 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3343 <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	3344 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3345 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3346 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	3347 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3348 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3349 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3350 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3351 <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	3352 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3353 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3354 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	3355 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3356 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3357 <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	3358 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3359 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3360 The time when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”, in the ISO 8601 format with millisecond resolution.
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3361 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3362 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3363 <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	3364 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3365 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3366 The time when the server was last selected to process a connection, in the ISO 8601 format with millisecond resolution.
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3367 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3368 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3369 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3370 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3371 <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	3372 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3373 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3374 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	3375 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3376 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3377 <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	3378 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3379 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3380 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	3381 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3382 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3383 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3384 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3385 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3386 "dns" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3387 "peers" : [
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3388 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3389 "id" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3390 "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	3391 "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	3392 "backup" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3393 "weight" : 5,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3394 "state" : "up",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3395 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3396 "max_conns" : 50,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3397 "connections" : 667231,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3398 "sent" : 251946292,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3399 "received" : 19222475454,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3400 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3401 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3402 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3403 "checks" : 26214,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3404 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3405 "unhealthy" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3406 "last_passed" : true
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3407 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3408 "downtime" : 0,
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3409 "downstart" : "2019-10-01T11:09:21.602Z",
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3410 "selected" : "2019-10-01T15:01:25.000Z"
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3411 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3412 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3413 "id" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3414 "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	3415 "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	3416 "backup" : true,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3417 "weight" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3418 "state" : "unhealthy",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3419 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3420 "max_conns" : 50,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3421 "connections" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3422 "sent" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3423 "received" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3424 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3425 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3426 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3427 "checks" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3428 "fails" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3429 "unhealthy" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3430 "last_passed" : false
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3431 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3432 "downtime" : 262925617,
2439 12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3433 "downstart" : "2019-10-01T11:09:21.602Z",
12716b241230 Updated versions and datastamps in the API reference. Yaroslav Zhuravlev <yar@nginx.com> parents: 2424 diff changeset	3434 "selected" : "2019-10-01T15:01:25.000Z"
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3435 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3436 ],
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3437 "zombies" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3438 "zone" : "dns"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3439 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3440 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3441 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3442 <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	3443 <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	3444 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	3445 <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	3446 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3447 <literal>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	3448 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3449 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3450 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	3451 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3452 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3453 <literal>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	3454 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3455 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3456 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	3457 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3458 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3459 <literal>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	3460 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3461 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3462 Same as the <link url="https://nginx.org/en/docs/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	3463 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3464 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3465 <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	3466 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3467 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3468 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	3469 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3470 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3471 <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	3472 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3473 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3474 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	3475 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3476 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3477 <literal>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	3478 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3479 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3480 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	3481 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3482 <tag-name>
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3483 <literal>fail_timeout</literal> (<literal>string</literal>)
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3484 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3485 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3486 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	3487 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3488 <tag-name>
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3489 <literal>slow_start</literal> (<literal>string</literal>)
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3490 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3491 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3492 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	3493 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3494 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3495 <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	3496 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3497 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3498 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	3499 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3500 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3501 <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	3502 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3503 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3504 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	3505 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3506 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3507 <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	3508 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3509 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3510 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	3511 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3512 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3513 <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	3514 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3515 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3516 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	3517 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3518 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3519 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3520 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3521 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3522 "id" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3523 "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	3524 "weight" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3525 "max_conns" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3526 "max_fails" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3527 "fail_timeout" : "10s",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3528 "slow_start" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3529 "backup" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3530 "down" : false
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3531 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3532 </listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3533 <listitem id="def_nginx_stream_keyval_zone">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3534 <para>Stream Keyval Shared Memory Zone:</para>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3535 Contents of a stream keyval shared memory zone when using the GET method.<para>Example:</para>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3536 <example>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3537 {
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3538 "key1" : "value1",
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3539 "key2" : "value2",
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3540 "key3" : "value3"
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3541 }</example>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3542 </listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3543 <listitem id="def_nginx_stream_keyval_zone_post_patch">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3544 <para>Stream Keyval Shared Memory Zone:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3545 Contents of a stream keyval shared memory zone
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3546 when using the POST or PATCH methods.<para>Example:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3547 <example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3548 {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3549 "key1" : "value1",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3550 "key2" : "value2",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3551 "key3" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3552 "value" : "value3",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3553 "expire" : 30000
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3554 }
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3555 }</example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3556 </listitem>
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3557 <listitem id="def_nginx_stream_zone_sync">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3558 <para>Stream Zone Sync Node:</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3559 <list type="tag">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3560 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3561 <literal>zones</literal></tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3562 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3563 <para>Synchronization information per each shared memory zone.</para><para>A collection of "<link id="def_nginx_stream_zone_sync_zone">Sync Zone</link>" objects</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3564 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3565 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3566 <literal>status</literal></tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3567 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3568 Synchronization information per node in a cluster.<list type="tag">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3569 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3570 <literal>bytes_in</literal> (<literal>integer</literal>)
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3571 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3572 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3573 The number of bytes received by this node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3574 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3575 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3576 <literal>msgs_in</literal> (<literal>integer</literal>)
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3577 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3578 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3579 The number of messages received by this node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3580 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3581 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3582 <literal>msgs_out</literal> (<literal>integer</literal>)
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3583 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3584 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3585 The number of messages sent by this node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3586 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3587 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3588 <literal>bytes_out</literal> (<literal>integer</literal>)
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3589 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3590 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3591 The number of bytes sent by this node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3592 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3593 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3594 <literal>nodes_online</literal> (<literal>integer</literal>)
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3595 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3596 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3597 The number of peers this node is connected to.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3598 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3599 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3600 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3601 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3602 <para>Example:</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3603 <example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3604 {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3605 "zones" : {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3606 "zone1" : {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3607 "records_pending" : 2061,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3608 "records_total" : 260575
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3609 },
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3610 "zone2" : {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3611 "records_pending" : 0,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3612 "records_total" : 14749
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3613 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3614 },
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3615 "status" : {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3616 "bytes_in" : 1364923761,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3617 "msgs_in" : 337236,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3618 "msgs_out" : 346717,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3619 "bytes_out" : 1402765472,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3620 "nodes_online" : 15
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3621 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3622 }</example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3623 </listitem>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3624 <listitem id="def_nginx_stream_zone_sync_zone">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3625 <para>Sync Zone:</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3626 Synchronization status of a shared memory zone.<list type="tag">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3627 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3628 <literal>records_pending</literal> (<literal>integer</literal>)
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3629 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3630 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3631 The number of records that need to be sent to the cluster.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3632 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3633 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3634 <literal>records_total</literal> (<literal>integer</literal>)
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3635 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3636 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3637 The total number of records stored in the shared memory zone.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3638 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3639 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3640 </listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3641 <listitem id="def_nginx_resolver_zone">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3642 <para>Resolver Zone:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3643 Statistics of DNS requests and responses per particular
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3644 <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</link>.<list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3645 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3646 <literal>requests</literal></tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3647 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3648 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3649 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3650 <literal>name</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3651 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3652 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3653 The total number of requests to resolve names to addresses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3654 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3655 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3656 <literal>srv</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3657 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3658 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3659 The total number of requests to resolve SRV records.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3660 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3661 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3662 <literal>addr</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3663 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3664 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3665 The total number of requests to resolve addresses to names.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3666 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3667 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3668 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3669 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3670 <literal>responses</literal></tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3671 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3672 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3673 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3674 <literal>noerror</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3675 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3676 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3677 The total number of successful responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3678 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3679 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3680 <literal>formerr</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3681 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3682 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3683 The total number of FORMERR (<literal>Format error</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3684 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3685 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3686 <literal>servfail</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3687 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3688 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3689 The total number of SERVFAIL (<literal>Server failure</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3690 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3691 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3692 <literal>nxdomain</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3693 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3694 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3695 The total number of NXDOMAIN (<literal>Host not found</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3696 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3697 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3698 <literal>notimp</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3699 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3700 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3701 The total number of NOTIMP (<literal>Unimplemented</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3702 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3703 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3704 <literal>refused</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3705 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3706 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3707 The total number of REFUSED (<literal>Operation refused</literal>) responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3708 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3709 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3710 <literal>timedout</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3711 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3712 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3713 The total number of timed out requests.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3714 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3715 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3716 <literal>unknown</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3717 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3718 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3719 The total number of requests completed with an unknown error.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3720 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3721 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3722 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3723 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3724 <para>Example:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3725 <example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3726 {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3727 "resolver_zone1" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3728 "requests" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3729 "name" : 25460,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3730 "srv" : 130,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3731 "addr" : 2580
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3732 },
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3733 "responses" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3734 "noerror" : 26499,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3735 "formerr" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3736 "servfail" : 3,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3737 "nxdomain" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3738 "notimp" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3739 "refused" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3740 "timedout" : 243,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3741 "unknown" : 478
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3742 }
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3743 }
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3744 }</example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3745 </listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3746 <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	3747 <para>Error:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3748 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	3749 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3750 <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	3751 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3752 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3753 <tag-name>
2132 a645aa9f2ebf Changed type of HTTP error code to integer in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2082 diff changeset	3754 <literal>status</literal> (<literal>integer</literal>)
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3755 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3756 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3757 HTTP error code.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3758 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3759 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3760 <literal>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	3761 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3762 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3763 Error description.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3764 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3765 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3766 <literal>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	3767 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3768 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3769 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	3770 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3771 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3772 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3773 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3774 <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	3775 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3776 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3777 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	3778 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3779 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3780 <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	3781 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3782 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3783 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	3784 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3785 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3786 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3787 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3788 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3789 </section>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3790
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3791 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_api_module.xml @ 2469:98fd810c13e0