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

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

Updated docs for the upcoming NGINX Plus release.

author	Ruslan Ermilov <ru@nginx.com>
date	Mon, 02 Sep 2019 14:12:20 +0300
parents	d5e576eb7677
children	12716b241230

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>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	104 http://127.0.0.1/api/5/
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	105 http://127.0.0.1/api/5/nginx
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	106 http://127.0.0.1/api/5/connections
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	107 http://127.0.0.1/api/5/http/requests
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	108 http://127.0.0.1/api/5/http/server_zones/server_backend
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	109 http://127.0.0.1/api/5/http/caches/cache_backend
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	110 http://127.0.0.1/api/5/http/upstreams/backend
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	111 http://127.0.0.1/api/5/http/upstreams/backend/servers/
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	112 http://127.0.0.1/api/5/http/upstreams/backend/servers/1
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	113 http://127.0.0.1/api/5/http/keyvals/one?key=arg1
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	114 http://127.0.0.1/api/5/stream/
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	115 http://127.0.0.1/api/5/stream/server_zones/server_backend
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	116 http://127.0.0.1/api/5/stream/upstreams/
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	117 http://127.0.0.1/api/5/stream/upstreams/backend
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	118 http://127.0.0.1/api/5/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.
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	149 The current API version is “<literal>5</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>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	156 http://127.0.0.1/api/5/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>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	202 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	203 <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	204 <link id="postHttpKeyvalZoneData">set</link> or
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	205 <link id="patchHttpKeyvalZoneKeyValue">changed</link>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	206 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	207 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	208
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	209 <listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	210 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	211 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	212 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	213
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	214 <listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	215 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	216 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	217 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	218
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	219 <listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	220 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	221 <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	222 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	223 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	224 but show an empty value.
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	225 </listitem>
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	226
d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	227 <listitem>
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	228 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	229 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	230 </listitem>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	231
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	232 <listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	233 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	234 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	235 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	236
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	237 <listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	238 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	239 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	240 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	241
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	242 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	243 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	244
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	245 </section>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	246 <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	247 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	248 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	249 <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	250 <literal>/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	251 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	252 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	253 <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	254 <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	255 <listitem id="getAPIEndpoints">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	256 <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	257 <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	258 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	259 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	260 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	261 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	262 <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	263 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	264 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	265 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	266 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	267 <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	268 <literal>/nginx</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	269 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	270 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	271 <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	272 <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	273 <listitem id="getNginx">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	274 <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	275 <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	276 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	277 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	278 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	279 <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	280 (<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	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 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	283 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	284 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	285 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	286 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	287 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	288 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	289 <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	290 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	291 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	292 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	293 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	294 <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	295 <literal>/processes</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	296 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	297 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	298 <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	299 <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	300 <listitem id="getProcesses">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	301 <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	302 <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	303 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	304 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	305 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	306 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	307 <listitem>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	308 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	309 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	310 <listitem id="deleteProcesses">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	311 <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	312 <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	313 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	314 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	315 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	316 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	317 <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	318 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	319 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	320 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	321 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	322 <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	323 <literal>/connections</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	324 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	325 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	326 <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	327 <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	328 <listitem id="getConnections">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	329 <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	330 <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	331 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	332 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	333 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	334 <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	335 (<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	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 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	338 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	339 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	340 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	341 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	342 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	343 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	344 <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	345 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	346 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	347 <listitem id="deleteConnections">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	348 <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	349 <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	350 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	351 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	352 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	353 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	354 <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	355 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	356 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	357 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	358 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	359 <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	360 <literal>/slabs/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	361 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	362 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	363 <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	364 <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	365 <listitem id="getSlabs">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	366 <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	367 <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	368 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	369 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	370 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	371 <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	372 (<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	373 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	374 Limits which fields of slab zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	375 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	376 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	377 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	378 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	379 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	380 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	381 <listitem>200 - Success, returns a collection of "<link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link>" objects for all slabs</listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	382 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	383 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	384 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	385 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	386 <tag-name id="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	387 <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	388 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	389 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	390 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	391 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	392 <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	393 (<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	394 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	395 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	396 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	397 <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	398 <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	399 <listitem id="getSlabZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	400 <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	401 <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	402 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	403 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	404 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	405 <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	406 (<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	407 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	408 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	409 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	410 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	411 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	412 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	413 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	414 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	415 <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	416 <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	417 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	418 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	419 <listitem id="deleteSlabZoneStats">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	420 <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	421 <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	422 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	423 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	424 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	425 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	426 <listitem>204 - Success</listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	427 <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	428 <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	429 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	430 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	431 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	432 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	433 <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	434 <literal>/http/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	435 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	436 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	437 <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	438 <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	439 <listitem id="getHttp">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	440 <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	441 <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	442 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	443 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	444 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	445 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	446 <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	447 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	448 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	449 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	450 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	451 <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	452 <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	453 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	454 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	455 <para>Supported methods:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	456 <list type="bullet" compact="yes">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	457 <listitem id="getHttpRequests">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	458 <literal>GET</literal> - Return HTTP requests statistics
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	459 <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	460 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	461 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	462 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	463 <tag-name><literal>fields</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	464 (<literal>string</literal>, optional)</tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	465 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	466 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	467 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	468 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	469 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	470 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	471 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	472 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	473 <listitem>200 - Success, returns <link id="def_nginx_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	474 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	475 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	476 <listitem id="deleteHttpRequests">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	477 <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	478 <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	479 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	480 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	481 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	482 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	483 <listitem>204 - Success</listitem>
2047 593dfdc524ae Documented the 405 error (Method Disabled) in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2046 diff changeset	484 <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	485 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	486 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	487 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	488 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	489 <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	490 <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	491 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	492 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	493 <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	494 <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	495 <listitem id="getHttpServerZones">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	496 <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	497 <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	498 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	499 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	500 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	501 <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	502 (<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	503 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	504 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	505 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	506 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	507 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	508 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	509 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	510 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	511 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_server_zone">HTTP Server Zone</link>" objects for all HTTP server zones</listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	512 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	513 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	514 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	515 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	516 <tag-name id="http_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	517 <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	518 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	519 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	520 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	521 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	522 <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	523 (<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	524 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	525 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	526 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	527 <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	528 <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	529 <listitem id="getHttpServerZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	530 <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	531 <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	532 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	533 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	534 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	535 <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	536 (<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	537 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	538 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	539 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	540 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	541 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	542 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	543 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	544 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	545 <listitem>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	546 <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	547 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	548 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	549 <listitem id="deleteHttpServerZoneStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	550 <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	551 <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	552 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	553 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	554 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	555 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	556 <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	557 <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	558 <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	559 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	560 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	561 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	562 </tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	563 <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	564 <literal>/http/location_zones/</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	565 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	566 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	567 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	568 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	569 <listitem id="getHttpLocationZones">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	570 <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	571 <para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	572 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	573 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	574 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	575 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	576 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	577 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	578 Limits which fields of location zones will be output. If the “<literal>fields</literal>” value is empty, then only zone names will be output.</tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	579 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	580 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	581 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	582 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	583 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	584 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	585 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_location_zone">HTTP Location Zone</link>" objects for all HTTP location zones</listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	586 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	587 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	588 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	589 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	590 <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	591 <literal>/http/location_zones/{httpLocationZoneName}</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	592 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	593 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	594 Parameters common for all methods:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	595 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	596 <tag-name><literal>httpLocationZoneName</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	597 (<literal>string</literal>, required)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	598 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	599 The name of an HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	600 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	601 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	602 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	603 <listitem id="getHttpLocationZone">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	604 <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	605 <para>Returns status of a particular HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone_location">location zone</link>.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	606 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	607 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	608 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	609 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	610 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	611 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	612 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	613 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	614 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	615 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	616 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	617 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	618 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	619 <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	620 <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	621 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	622 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	623 <listitem id="deleteHttpLocationZoneStat">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	624 <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	625 <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	626 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	627 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	628 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	629 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	630 <listitem>204 - Success</listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	631 <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	632 <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	633 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	634 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	635 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	636 </tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	637 <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	638 <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	639 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	640 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	641 <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	642 <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	643 <listitem id="getHttpCaches">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	644 <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	645 <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	646 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	647 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	648 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	649 <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	650 (<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	651 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	652 Limits which fields of cache zones will be output. If the “<literal>fields</literal>” value is empty, then only names of cache zones will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	653 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	654 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	655 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	656 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	657 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	658 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	659 <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	660 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	661 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	662 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	663 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	664 <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	665 <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	666 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	667 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	668 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	669 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	670 <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	671 (<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	672 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	673 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	674 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	675 <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	676 <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	677 <listitem id="getHttpCacheZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	678 <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	679 <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	680 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	681 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	682 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	683 <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	684 (<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	685 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	686 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	687 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	688 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	689 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	690 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	691 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	692 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	693 <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	694 <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	695 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	696 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	697 <listitem id="deleteHttpCacheZoneStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	698 <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	699 <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	700 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	701 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	702 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	703 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	704 <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	705 <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	706 <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	707 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	708 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	709 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	710 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	711 <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	712 <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	713 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	714 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	715 <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	716 <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	717 <listitem id="getHttpUpstreams">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	718 <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	719 <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	720 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	721 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	722 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	723 <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	724 (<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	725 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	726 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	727 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	728 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	729 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	730 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	731 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	732 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	733 <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	734 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	735 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	736 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	737 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	738 <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	739 <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	740 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	741 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	742 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	743 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	744 <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	745 (<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	746 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	747 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	748 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	749 <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	750 <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	751 <listitem id="getHttpUpstreamName">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	752 <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	753 <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	754 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	755 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	756 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	757 <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	758 (<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	759 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	760 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	761 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	762 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	763 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	764 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	765 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	766 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	767 <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	768 <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	769 <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	770 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	771 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	772 <listitem id="deleteHttpUpstreamStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	773 <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	774 <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	775 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	776 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	777 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	778 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	779 <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	780 <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	781 <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	782 <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	783 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	784 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	785 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	786 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	787 <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	788 <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	789 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	790 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	791 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	792 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	793 <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	794 (<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	795 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	796 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	797 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	798 <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	799 <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	800 <listitem id="getHttpUpstreamServers">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	801 <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	802 <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	803 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	804 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	805 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	806 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	807 <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	808 <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	809 <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	810 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	811 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	812 <listitem id="postHttpUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	813 <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	814 <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	815 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	816 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	817 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	818 <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	819 (<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	820 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	821 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	822 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	823 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	824 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	825 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	826 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	827 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	828 <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	829 <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	830 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	831 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	832 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	833 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	834 “<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	835 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	836 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	837 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	838 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	839 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	840 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	841 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	842 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	843 “<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	844 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	845 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	846 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	847 <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	848 <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	849 <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	850 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	851 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	852 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	853 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	854 <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	855 <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	856 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	857 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	858 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	859 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	860 <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	861 (<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	862 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	863 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	864 <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	865 (<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	866 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	867 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	868 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	869 <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	870 <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	871 <listitem id="getHttpUpstreamPeer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	872 <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	873 <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	874 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	875 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	876 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	877 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	878 <listitem>200 - Success, returns <link id="def_nginx_http_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	879 <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	880 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	881 <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	882 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	883 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	884 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	885 <listitem id="patchHttpUpstreamPeer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	886 <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	887 <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	888 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	889 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	890 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	891 <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	892 (<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	893 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	894 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	895 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	896 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	897 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	898 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	899 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	900 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	901 <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	902 <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	903 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	904 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	905 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	906 “<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	907 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	908 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	909 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	910 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	911 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	912 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	913 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	914 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	915 “<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	916 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	917 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	918 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	919 <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	920 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	921 <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	922 <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	923 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	924 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	925 <listitem id="deleteHttpUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	926 <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	927 <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	928 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	929 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	930 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	931 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	932 <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	933 <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	934 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	935 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	936 <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	937 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	938 <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	939 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	940 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	941 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	942 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	943 <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	944 <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	945 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	946 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	947 <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	948 <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	949 <listitem id="getHttpKeyvalZones">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	950 <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	951 <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	952 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	953 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	954 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	955 <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	956 (<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	957 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	958 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	959 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	960 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	961 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	962 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	963 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	964 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	965 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link>" objects for all HTTP keyvals</listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	966 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	967 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	968 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	969 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	970 <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	971 <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	972 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	973 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	974 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	975 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	976 <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	977 (<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	978 <tag-desc>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	979 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	980 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	981 <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	982 <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	983 <listitem id="getHttpKeyvalZoneKeysValues">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	984 <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	985 <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	986 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	987 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	988 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	989 <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	990 (<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	991 <tag-desc>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	992 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	993 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	994 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	995 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	996 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	997 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	998 <list type="bullet">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	999 <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	1000 <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	1001 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	1002 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1003 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1004 <listitem id="postHttpKeyvalZoneData">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1005 <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	1006 <para>Adds a new key-value pair to the HTTP keyval shared memory <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty.</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1007 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1008 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1009 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1010 <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	1011 (<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	1012 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1013 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the HTTP keyval shared memory zone is empty. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</link> directive.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1014 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1015 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1016 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1017 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1018 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1019 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1020 <listitem>201 - Created</listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1021 <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	1022 invalid key format (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1023 key required (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1024 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	1025 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	1026 <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	1027 <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	1028 <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	1029 <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	1030 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1031 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1032 <listitem id="patchHttpKeyvalZoneKeyValue">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1033 <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	1034 <para>Changes the value of the selected key in the key-value pair, deletes a key by setting the key value to <literal>null</literal>, changes expiration time of a key-value pair. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">keyval_zone</link> directive.</para>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1035 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1036 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1037 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1038 <tag-name><literal>httpKeyvalZoneKeyValue</literal>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1039 (<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	1040 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1041 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	1042 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1043 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1044 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1045 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1046 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1047 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1048 <listitem>204 - Success</listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1049 <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	1050 key required (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1051 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	1052 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	1053 <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	1054 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	1055 <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	1056 <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	1057 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1058 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1059 <listitem id="deleteHttpKeyvalZoneData">
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1060 <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	1061 <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	1062 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1063 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1064 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1065 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1066 <listitem>204 - Success</listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1067 <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	1068 <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	1069 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1070 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1071 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1072 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1073 <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	1074 <literal>/stream/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1075 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1076 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1077 <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	1078 <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	1079 <listitem id="getStream">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1080 <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	1081 <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	1082 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1083 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1084 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1085 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1086 <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	1087 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1088 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1089 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1090 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1091 <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	1092 <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	1093 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1094 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1095 <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	1096 <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	1097 <listitem id="getStreamServerZones">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1098 <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	1099 <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	1100 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1101 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1102 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1103 <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	1104 (<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	1105 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1106 Limits which fields of server zones will be output. If the “<literal>fields</literal>” value is empty, then only server zone names will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1107 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1108 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1109 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1110 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1111 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1112 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1113 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_server_zone">Stream Server Zone</link>" objects for all stream server zones</listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1114 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1115 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1116 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1117 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1118 <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	1119 <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	1120 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1121 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1122 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	1123 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1124 <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	1125 (<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	1126 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1127 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	1128 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1129 <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	1130 <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	1131 <listitem id="getStreamServerZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1132 <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	1133 <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	1134 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1135 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1136 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1137 <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	1138 (<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	1139 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1140 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	1141 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1142 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1143 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1144 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1145 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1146 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1147 <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	1148 <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	1149 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1150 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1151 <listitem id="deleteStreamServerZoneStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1152 <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	1153 <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	1154 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1155 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1156 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1157 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1158 <listitem>204 - Success</listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1159 <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	1160 <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	1161 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1162 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1163 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1164 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1165 <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	1166 <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	1167 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1168 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1169 <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	1170 <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	1171 <listitem id="getStreamUpstreams">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1172 <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	1173 <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	1174 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1175 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1176 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1177 <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	1178 (<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	1179 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1180 Limits which fields of upstream server groups will be output. If the “<literal>fields</literal>” value is empty, only names of upstreams will be output.</tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1181 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1182 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1183 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1184 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1185 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1186 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1187 <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	1188 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1189 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1190 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1191 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1192 <tag-name id="stream_upstreams_stream_upstream_name_" 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	1193 <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	1194 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1195 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1196 Parameters common for all methods:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1197 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1198 <tag-name><literal>streamUpstreamName</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1199 (<literal>string</literal>, required)</tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1200 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1201 The name of 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	1202 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1203 <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	1204 <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	1205 <listitem id="getStreamUpstream">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1206 <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	1207 <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	1208 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1209 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1210 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1211 <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	1212 (<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	1213 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1214 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	1215 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1216 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1217 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1218 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1219 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1220 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1221 <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	1222 <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	1223 <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	1224 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1225 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1226 <listitem id="deleteStreamUpstreamStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1227 <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	1228 <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	1229 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1230 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1231 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1232 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1233 <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	1234 <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	1235 <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	1236 <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	1237 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1238 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1239 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1240 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1241 <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	1242 <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	1243 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1244 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1245 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	1246 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1247 <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	1248 (<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	1249 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1250 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	1251 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1252 <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	1253 <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	1254 <listitem id="getStreamUpstreamServers">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1255 <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	1256 <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	1257 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1258 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1259 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1260 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1261 <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	1262 <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	1263 <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	1264 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1265 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1266 <listitem id="postStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1267 <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	1268 <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	1269 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1270 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1271 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1272 <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	1273 (<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	1274 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1275 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	1276 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1277 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1278 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1279 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1280 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1281 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1282 <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	1283 <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	1284 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	1285 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	1286 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	1287 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	1288 “<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	1289 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	1290 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	1291 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	1292 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	1293 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	1294 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	1295 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	1296 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	1297 “<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	1298 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	1299 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	1300 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	1301 <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	1302 <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	1303 <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	1304 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1305 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1306 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1307 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1308 <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	1309 <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	1310 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1311 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1312 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	1313 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1314 <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	1315 (<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	1316 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1317 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	1318 <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	1319 (<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	1320 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1321 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	1322 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1323 <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	1324 <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	1325 <listitem id="getStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1326 <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	1327 <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	1328 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1329 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1330 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1331 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1332 <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	1333 <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	1334 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	1335 <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	1336 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	1337 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1338 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1339 <listitem id="patchStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1340 <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	1341 <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	1342 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1343 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1344 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1345 <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	1346 (<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	1347 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1348 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	1349 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1350 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1351 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1352 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1353 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1354 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1355 <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	1356 <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	1357 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	1358 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	1359 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	1360 “<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	1361 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	1362 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	1363 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	1364 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	1365 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	1366 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	1367 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	1368 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	1369 “<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	1370 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	1371 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	1372 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	1373 <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	1374 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	1375 <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	1376 <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	1377 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1378 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1379 <listitem id="deleteStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1380 <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	1381 <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	1382 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1383 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1384 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1385 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1386 <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	1387 <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	1388 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	1389 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	1390 <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	1391 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	1392 <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	1393 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1394 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1395 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1396 </tag-desc>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1397 <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	1398 <literal>/stream/keyvals/</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1399 </tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1400 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1401 <para>Supported methods:</para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1402 <list type="bullet" compact="yes">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1403 <listitem id="getStreamKeyvalZones">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1404 <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	1405 <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	1406 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1407 Request parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1408 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1409 <tag-name><literal>fields</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1410 (<literal>string</literal>, optional)</tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1411 <tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1412 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	1413 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1414 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1415 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1416 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1417 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1418 <list type="bullet">
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1419 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link>" objects for all stream keyvals</listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1420 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1421 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1422 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1423 </tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1424 <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	1425 <literal>/stream/keyvals/{streamKeyvalZoneName}</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1426 </tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1427 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1428 Parameters common for all methods:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1429 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1430 <tag-name><literal>streamKeyvalZoneName</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1431 (<literal>string</literal>, required)</tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1432 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1433 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	1434 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1435 <para>Supported methods:</para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1436 <list type="bullet" compact="yes">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1437 <listitem id="getStreamKeyvalZoneKeysValues">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1438 <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	1439 <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	1440 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1441 Request parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1442 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1443 <tag-name><literal>key</literal>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1444 (<literal>string</literal>, optional)</tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1445 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1446 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	1447 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1448 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1449 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1450 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1451 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1452 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1453 <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	1454 <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	1455 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	1456 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1457 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1458 <listitem id="postStreamKeyvalZoneData">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1459 <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	1460 <para>Adds a new key-value pair to the stream keyval shared memory <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">zone</link>. Several key-value pairs can be entered if the stream keyval shared memory zone is empty.</para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1461 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1462 Request parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1463 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1464 <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	1465 (<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	1466 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1467 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the stream keyval shared memory zone is empty. Expiration time in milliseconds can be specified for a key-value pair with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</link> directive.</tag-desc>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1468 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1469 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1470 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1471 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1472 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1473 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1474 <listitem>201 - Created</listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1475 <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	1476 invalid key format (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1477 key required (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1478 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	1479 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	1480 <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	1481 <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	1482 <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	1483 <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	1484 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1485 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1486 <listitem id="patchStreamKeyvalZoneKeyValue">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1487 <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	1488 <para>Changes the value of the selected key in the key-value pair, deletes a key by setting the key value to <literal>null</literal>, changes expiration time of a key-value pair. If <link url="https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync">synchronization</link> of keyval zones in a cluster is enabled, deletes a key only on a target cluster node. Expiration time is specified in milliseconds with the <literal>expire</literal> parameter which overrides the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_timeout"><literal>timeout</literal></link> parameter of the <link url="https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html#keyval_zone">keyval_zone</link> directive.</para>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1489 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1490 Request parameters:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1491 <list type="tag">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1492 <tag-name><literal>streamKeyvalZoneKeyValue</literal>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1493 (<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	1494 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1495 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	1496 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1497 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1498 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1499 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1500 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1501 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1502 <listitem>204 - Success</listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1503 <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	1504 key required (<literal>KeyvalFormatError</literal>),
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1505 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	1506 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	1507 <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	1508 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	1509 <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	1510 <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	1511 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1512 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1513 <listitem id="deleteStreamKeyvalZoneData">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1514 <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	1515 <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	1516 <para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1517 Possible responses:
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1518 </para>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1519 <list type="bullet">
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1520 <listitem>204 - Success</listitem>
2359 d5e576eb7677 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2253 diff changeset	1521 <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	1522 <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	1523 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1524 </listitem>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1525 </list>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	1526 </tag-desc>
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1527 <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	1528 <literal>/stream/zone_sync/</literal>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1529 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1530 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1531 <para>Supported methods:</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1532 <list type="bullet" compact="yes">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1533 <listitem id="getStreamZoneSync">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1534 <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	1535 <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	1536 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1537 Possible responses:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1538 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1539 <list type="bullet">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1540 <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	1541 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1542 </listitem>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1543 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	1544 </tag-desc>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1545 <tag-name id="resolvers_" name="/resolvers/">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1546 <literal>/resolvers/</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1547 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1548 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1549 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1550 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1551 <listitem id="getResolverZones">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1552 <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	1553 <para>Returns status information for each <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">resolver zone</link>.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1554 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1555 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1556 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1557 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1558 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1559 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1560 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	1561 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1562 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1563 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1564 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1565 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1566 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1567 <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	1568 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1569 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1570 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1571 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1572 <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	1573 <literal>/resolvers/{resolverZoneName}</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1574 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1575 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1576 Parameters common for all methods:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1577 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1578 <tag-name><literal>resolverZoneName</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1579 (<literal>string</literal>, required)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1580 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1581 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	1582 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1583 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1584 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1585 <listitem id="getResolverZone">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1586 <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	1587 <para>Returns statistics stored in a particular resolver <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver_status_zone">zone</link>.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1588 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1589 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1590 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1591 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1592 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1593 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1594 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	1595 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1596 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1597 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1598 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1599 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1600 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1601 <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	1602 <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	1603 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1604 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1605 <listitem id="deleteResolverZoneStat">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1606 <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	1607 <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	1608 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1609 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1610 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1611 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1612 <listitem>204 - Success</listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1613 <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	1614 <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	1615 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1616 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1617 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1618 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1619 <tag-name id="ssl" name="/ssl">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1620 <literal>/ssl</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1621 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1622 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1623 <para>Supported methods:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1624 <list type="bullet" compact="yes">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1625 <listitem id="getSsl">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1626 <literal>GET</literal> - Return SSL statistics
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1627 <para>Returns SSL statistics.</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1628 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1629 Request parameters:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1630 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1631 <tag-name><literal>fields</literal>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1632 (<literal>string</literal>, optional)</tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1633 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1634 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	1635 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1636 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1637 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1638 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1639 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1640 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1641 <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	1642 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1643 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1644 <listitem id="deleteSslStat">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1645 <literal>DELETE</literal> - Reset SSL statistics
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1646 <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	1647 <para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1648 Possible responses:
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1649 </para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1650 <list type="bullet">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1651 <listitem>204 - Success</listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1652 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1653 </listitem>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1654 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	1655 </tag-desc>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1656 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1657 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1658 </section>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1659 <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	1660 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1661 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1662 <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	1663 <para>nginx:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1664 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	1665 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1666 <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	1667 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1668 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1669 Version of nginx.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1670 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1671 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1672 <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	1673 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1674 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1675 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	1676 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1677 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1678 <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	1679 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1680 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1681 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	1682 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1683 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1684 <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	1685 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1686 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1687 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	1688 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1689 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1690 <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	1691 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1692 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1693 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	1694 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1695 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1696 <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	1697 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1698 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1699 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	1700 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1701 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1702 <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	1703 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1704 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1705 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	1706 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1707 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1708 <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	1709 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1710 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1711 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	1712 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1713 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1714 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1715 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1716 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1717 "nginx" : {
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1718 "version" : "1.15.2",
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1719 "build" : "nginx-plus-r16",
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1720 "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	1721 "generation" : 6,
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1722 "load_timestamp" : "2018-10-08T09:05:48.776Z",
a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	1723 "timestamp" : "2018-10-08T15:23:17.056Z",
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1724 "pid" : 32212,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1725 "ppid" : 32210
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1726 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1727 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1728 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1729 <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	1730 <para>Processes:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1731 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1732 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1733 <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	1734 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1735 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1736 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	1737 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1738 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1739 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1740 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1741 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1742 "respawned" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1743 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1744 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1745 <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	1746 <para>Connections:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1747 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	1748 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1749 <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	1750 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1751 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1752 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	1753 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1754 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1755 <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	1756 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1757 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1758 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	1759 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1760 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1761 <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	1762 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1763 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1764 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	1765 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1766 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1767 <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	1768 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1769 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1770 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	1771 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1772 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1773 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1774 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1775 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1776 "accepted" : 4968119,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1777 "dropped" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1778 "active" : 5,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1779 "idle" : 117
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1780 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1781 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1782 <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	1783 <para>SSL:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1784 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1785 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1786 <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	1787 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1788 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1789 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	1790 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1791 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1792 <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	1793 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1794 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1795 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	1796 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1797 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1798 <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	1799 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1800 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1801 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	1802 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1803 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1804 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1805 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1806 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1807 "handshakes" : 79572,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1808 "handshakes_failed" : 21025,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1809 "session_reuses" : 15762
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1810 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1811 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1812 <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	1813 <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	1814 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1815 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1816 <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	1817 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1818 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	1819 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1820 <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	1821 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1822 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1823 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	1824 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1825 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1826 <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	1827 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1828 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1829 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	1830 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1831 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1832 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1833 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1834 <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	1835 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1836 <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	1837 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1838 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1839 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1840 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1841 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1842 "pages" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1843 "used" : 1143,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1844 "free" : 2928
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1845 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1846 "slots" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1847 "8" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1848 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1849 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1850 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1851 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1852 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1853 "16" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1854 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1855 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1856 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1857 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1858 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1859 "32" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1860 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1861 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1862 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1863 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1864 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1865 "64" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1866 "used" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1867 "free" : 63,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1868 "reqs" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1869 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1870 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1871 "128" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1872 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1873 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1874 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1875 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1876 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1877 "256" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1878 "used" : 18078,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1879 "free" : 178,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1880 "reqs" : 1635736,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1881 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1882 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1883 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1884 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1885 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1886 <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	1887 <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	1888 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1889 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1890 <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	1891 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1892 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1893 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	1894 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1895 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1896 <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	1897 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1898 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1899 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	1900 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1901 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1902 <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	1903 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1904 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1905 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	1906 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1907 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1908 <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	1909 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1910 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1911 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	1912 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1913 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1914 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1915 <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	1916 <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	1917 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1918 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1919 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1922 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	1923 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1924 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1925 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1928 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	1929 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1930 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1931 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1932 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1933 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1934 "total" : 10624511,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1935 "current" : 4
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1936 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1937 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1938 <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	1939 <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	1940 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1941 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1942 <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	1943 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1944 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1945 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	1946 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1947 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1948 <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	1949 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1950 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1951 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	1952 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1953 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1954 <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	1955 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1956 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	1957 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1958 <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	1959 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1960 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1961 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	1962 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1963 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1964 <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	1965 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1966 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1967 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	1968 </tag-desc>
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>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	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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1973 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1976 <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	1977 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1978 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1979 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	1980 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1981 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1982 <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	1983 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1984 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1985 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	1986 </tag-desc>
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 <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	1989 </tag-name>
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 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	1992 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1993 </list>
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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1996 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1999 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2002 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2005 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2008 <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	2009 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2010 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2011 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	2012 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2013 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2014 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2015 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2016 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2017 "processing" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2018 "requests" : 706690,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2019 "responses" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2020 "1xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2021 "2xx" : 699482,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2022 "3xx" : 4522,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2023 "4xx" : 907,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2024 "5xx" : 266,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2025 "total" : 705177
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2026 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2027 "discarded" : 1513,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2028 "received" : 172711587,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2029 "sent" : 19415530115
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2030 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2031 </listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2032 <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	2033 <para>HTTP Location Zone:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2034 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2035 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2036 <literal>requests</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2037 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2038 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2039 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	2040 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2041 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2042 <literal>responses</literal></tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2043 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2044 The total number of responses sent to clients and the number of responses with status codes “<literal>1xx</literal>”, “<literal>2xx</literal>”, “<literal>3xx</literal>”, “<literal>4xx</literal>”, and “<literal>5xx</literal>”.<list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2045 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2046 <literal>1xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2047 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2048 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2049 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	2050 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2051 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2052 <literal>2xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2053 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2054 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2055 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	2056 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2057 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2058 <literal>3xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2059 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2060 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2061 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	2062 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2063 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2064 <literal>4xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2065 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2066 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2067 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	2068 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2069 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2070 <literal>5xx</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2071 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2072 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2073 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	2074 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2075 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2076 <literal>total</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2077 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2078 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2079 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	2080 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2081 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2082 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2083 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2084 <literal>discarded</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2085 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2086 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2087 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	2088 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2089 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2090 <literal>received</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2091 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2092 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2093 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	2094 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2095 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2096 <literal>sent</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2097 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2098 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2099 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	2100 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2101 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2102 <para>Example:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2103 <example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2104 {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2105 "requests" : 706690,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2106 "responses" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2107 "1xx" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2108 "2xx" : 699482,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2109 "3xx" : 4522,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2110 "4xx" : 907,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2111 "5xx" : 266,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2112 "total" : 705177
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2113 },
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2114 "discarded" : 1513,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2115 "received" : 172711587,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2116 "sent" : 19415530115
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2117 }</example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2118 </listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2119 <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	2120 <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	2121 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2122 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2123 <literal>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	2124 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2125 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2126 The current 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	2127 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2128 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2129 <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	2130 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2131 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2132 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	2133 </tag-desc>
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 <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	2136 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2137 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2138 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	2139 </tag-desc>
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 <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	2142 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2143 <list type="tag">
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>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	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 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2151 <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	2152 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2153 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2154 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	2155 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2156 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2157 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2158 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2159 <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	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 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2162 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2163 <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	2164 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2165 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2166 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	2167 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2168 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2169 <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	2170 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2171 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2172 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	2173 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2174 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2175 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2176 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2177 <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	2178 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2179 <list type="tag">
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 <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	2182 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2183 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2184 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	2185 </tag-desc>
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 <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	2188 </tag-name>
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 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	2191 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2192 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2193 </tag-desc>
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>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	2196 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2197 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2198 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2199 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2202 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2205 <literal>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	2206 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2207 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2208 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	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 </list>
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>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	2214 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2215 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2216 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2217 <literal>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	2218 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2219 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2220 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	2221 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2222 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2223 <literal>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	2224 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2225 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2226 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	2227 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2228 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2229 <literal>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	2230 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2231 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2232 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	2233 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2234 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2235 <literal>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	2236 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2237 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2238 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	2239 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2240 </list>
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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2243 <literal>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	2244 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2245 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2246 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2247 <literal>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	2248 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2249 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2250 The 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	2251 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2252 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2253 <literal>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	2254 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2255 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2256 The 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	2257 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2258 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2259 <literal>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	2260 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2261 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2262 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	2263 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2264 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2265 <literal>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	2266 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2267 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2268 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	2269 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2270 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2271 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2272 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2273 <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	2274 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2275 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2276 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2277 <literal>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	2278 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2279 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2280 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	2281 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2282 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2283 <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	2284 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2285 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2286 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	2287 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2288 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2289 <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	2290 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2291 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2292 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	2293 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2294 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2295 <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	2296 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2297 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2298 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	2299 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2300 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2301 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2302 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2303 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2304 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2305 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2306 "size" : 530915328,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2307 "max_size" : 536870912,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2308 "cold" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2309 "hit" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2310 "responses" : 254032,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2311 "bytes" : 6685627875
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2312 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2313 "stale" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2314 "responses" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2315 "bytes" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2316 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2317 "updating" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2318 "responses" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2319 "bytes" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2320 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2321 "revalidated" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2322 "responses" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2323 "bytes" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2324 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2325 "miss" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2326 "responses" : 1619201,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2327 "bytes" : 53841943822
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2328 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2329 "expired" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2330 "responses" : 45859,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2331 "bytes" : 1656847080,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2332 "responses_written" : 44992,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2333 "bytes_written" : 1641825173
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2334 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2335 "bypass" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2336 "responses" : 200187,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2337 "bytes" : 5510647548,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2338 "responses_written" : 200173,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2339 "bytes_written" : 44992
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2340 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2341 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2342 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2343 <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	2344 <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	2345 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2346 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2347 <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	2348 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2349 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	2350 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2351 <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	2352 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2353 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2354 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	2355 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2356 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2357 <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	2358 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2359 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2360 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	2361 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2362 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2363 <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	2364 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2365 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2366 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	2367 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2368 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2369 <literal>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	2370 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2371 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2372 The 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	2373 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2374 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2375 <literal>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	2376 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2377 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2378 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	2379 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2380 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2381 <literal>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	2382 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2383 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2384 <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	2385 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2386 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2387 <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	2388 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2389 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2390 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	2391 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2392 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2393 <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	2394 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2395 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2396 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2399 <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	2400 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2401 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2402 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	2403 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2404 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2405 <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	2406 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2407 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2408 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	2409 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2410 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2411 <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	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 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2414 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2415 <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	2416 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2417 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2418 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	2419 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2420 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2421 <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	2422 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2423 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2424 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	2425 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2426 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2427 <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	2428 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2429 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2430 The 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	2431 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2432 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2433 <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	2434 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2435 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2436 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	2437 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2438 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2439 <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	2440 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2441 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2442 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	2443 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2444 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2445 <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	2446 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2447 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2448 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	2449 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2450 </list>
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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2453 <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	2454 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2455 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2456 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	2457 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2458 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2459 <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	2460 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2461 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2462 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	2463 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2464 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2465 <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	2466 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2467 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2468 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	2469 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2470 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2471 <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	2472 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2473 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2474 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	2475 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2476 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2477 <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	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 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2480 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2481 <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	2482 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2483 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2484 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	2485 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2486 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2487 <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	2488 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2489 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2490 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	2491 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2492 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2493 <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	2494 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2495 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2496 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	2497 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2498 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2499 <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	2500 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2501 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2502 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	2503 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2504 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2505 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2506 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2507 <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	2508 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2509 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2510 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2513 <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	2514 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2515 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	2516 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	2517 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2518 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2519 <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	2520 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2521 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	2522 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	2523 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2524 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2525 <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	2526 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2527 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2528 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	2529 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2530 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2531 <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	2532 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2533 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2534 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	2535 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2536 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2537 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2538 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2539 <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	2540 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2541 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2542 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	2543 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2544 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2545 <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	2546 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2547 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2548 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	2549 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2550 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2551 <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	2552 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2553 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2554 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	2555 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2556 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2557 <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	2558 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2559 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	2560 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2561 <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	2562 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2563 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2564 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	2565 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2566 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2567 <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	2568 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2569 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2570 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	2571 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2572 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2573 <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	2574 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2575 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2576 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	2577 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2578 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2579 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2580 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2581 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2582 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2583 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2584 "upstream_backend" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2585 "peers" : [
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2586 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2587 "id" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2588 "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	2589 "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	2590 "backup" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2591 "weight" : 5,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2592 "state" : "up",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2593 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2594 "max_conns" : 20,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2595 "requests" : 667231,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2596 "header_time" : 20,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2597 "response_time" : 36,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2598 "responses" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2599 "1xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2600 "2xx" : 666310,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2601 "3xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2602 "4xx" : 915,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2603 "5xx" : 6,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2604 "total" : 667231
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2605 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2606 "sent" : 251946292,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2607 "received" : 19222475454,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2608 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2609 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2610 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2611 "checks" : 26214,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2612 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2613 "unhealthy" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2614 "last_passed" : true
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2615 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2616 "downtime" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2617 "downstart" : "2017-07-07T11:09:21.602Z",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2618 "selected" : "2017-07-17T15:01:25.000Z"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2619 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2620 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2621 "id" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2622 "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	2623 "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	2624 "backup" : true,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2625 "weight" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2626 "state" : "unhealthy",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2627 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2628 "max_conns" : 20,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2629 "requests" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2630 "responses" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2631 "1xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2632 "2xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2633 "3xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2634 "4xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2635 "5xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2636 "total" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2637 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2638 "sent" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2639 "received" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2640 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2641 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2642 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2643 "checks" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2644 "fails" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2645 "unhealthy" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2646 "last_passed" : false
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2647 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2648 "downtime" : 262925617,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2649 "downstart" : "2017-07-07T11:09:21.602Z",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2650 "selected" : "2017-07-17T15:01:25.000Z"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2651 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2652 ],
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2653 "keepalive" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2654 "zombies" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2655 "zone" : "upstream_backend"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2656 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2657 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2658 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2659 <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	2660 <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	2661 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	2662 <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	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 <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	2665 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2666 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2667 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	2668 </tag-desc>
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 <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	2671 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2672 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2673 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	2674 </tag-desc>
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 <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	2677 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2678 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2679 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	2680 </tag-desc>
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 <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	2683 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2684 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2685 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	2686 </tag-desc>
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 <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	2689 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2690 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2691 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	2692 </tag-desc>
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 <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	2695 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2696 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2697 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	2698 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2699 <tag-name>
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	2700 <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	2701 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2702 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2703 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	2704 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2705 <tag-name>
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	2706 <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	2707 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2708 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2709 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	2710 </tag-desc>
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 <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	2713 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2714 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2715 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	2716 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2717 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2718 <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	2719 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2720 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2721 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	2722 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2723 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2724 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2727 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	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 <tag-name>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	2730 <literal>drain</literal> (<literal>boolean</literal>)
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	2731 </tag-name>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	2732 <tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	2733 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	2734 </tag-desc>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	2735 <tag-name>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2736 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2739 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2742 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2745 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	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 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2748 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2749 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2750 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2751 "id" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2752 "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	2753 "weight" : 4,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2754 "max_conns" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2755 "max_fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2756 "fail_timeout" : "10s",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2757 "slow_start" : "10s",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2758 "route" : "",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2759 "backup" : true,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2760 "down" : true
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2761 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2762 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2763 <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	2764 <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	2765 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	2766 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	2767 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2768 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2769 "key1" : "value1",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2770 "key2" : "value2",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2771 "key3" : "value3"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2772 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2773 </listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2774 <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	2775 <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	2776 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	2777 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	2778 <example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2779 {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2780 "key1" : "value1",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2781 "key2" : "value2",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2782 "key3" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2783 "value" : "value3",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2784 "expire" : 30000
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2785 }
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2786 }</example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	2787 </listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2788 <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	2789 <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	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>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	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 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	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>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	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 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	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>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	2805 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2806 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	2807 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2808 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2811 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	2812 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2813 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2814 <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	2815 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2816 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2817 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	2818 </tag-desc>
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 <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	2821 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2822 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2823 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	2824 </tag-desc>
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 <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	2827 </tag-name>
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 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	2830 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2831 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2832 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2833 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2834 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2837 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	2838 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2839 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2840 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2843 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	2844 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2845 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2846 <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	2847 </tag-name>
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 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	2850 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2851 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2852 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2853 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2854 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2855 "dns" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2856 "processing" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2857 "connections" : 155569,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2858 "sessions" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2859 "2xx" : 155564,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2860 "4xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2861 "5xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2862 "total" : 155569
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2863 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2864 "discarded" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2865 "received" : 4200363,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2866 "sent" : 20489184
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2867 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2868 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2869 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2870 <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	2871 <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	2872 <list type="tag">
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 <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	2875 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2876 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	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>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	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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2881 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	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>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	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>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2887 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2890 <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	2891 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2892 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2893 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	2894 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2895 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2896 <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	2897 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2898 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2899 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	2900 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2901 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2902 <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	2903 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2904 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2905 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	2906 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2907 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2908 <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	2909 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2910 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2911 <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	2912 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2913 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2914 <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	2915 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2916 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2917 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	2918 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2919 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2920 <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	2921 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2922 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2923 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	2924 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2925 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2926 <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	2927 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2928 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2929 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	2930 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2931 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2932 <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	2933 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2934 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2935 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	2936 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2937 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2938 <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	2939 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2940 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2941 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	2942 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2943 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2944 <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	2945 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2946 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2947 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	2948 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2949 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2950 <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	2951 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2952 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2953 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	2954 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2955 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2956 <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	2957 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2958 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2959 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	2960 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2961 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2962 <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	2963 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2964 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2965 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	2966 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2967 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2968 <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	2969 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2970 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2971 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	2972 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2973 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2974 <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	2975 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2976 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2977 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	2978 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2979 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2980 <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	2981 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2982 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2983 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2984 <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	2985 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2986 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2987 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	2988 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2989 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2990 <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	2991 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2992 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2993 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	2994 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2995 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2996 <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	2997 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2998 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2999 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	3000 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3001 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3002 <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	3003 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3004 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3005 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	3006 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3007 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3008 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3009 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3010 <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	3011 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3012 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3013 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	3014 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3015 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3016 <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	3017 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3018 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3019 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	3020 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3021 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3022 <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	3023 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3024 <tag-desc>
2253 a89093ff86a3 Clarified ISO 8601 time, changed example, bumped version in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2221 diff changeset	3025 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	3026 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3027 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3028 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3029 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3030 <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	3031 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3032 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3033 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	3034 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3035 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3036 <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	3037 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3038 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3039 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	3040 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3041 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3042 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3043 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3044 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3045 "dns" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3046 "peers" : [
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3047 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3048 "id" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3049 "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	3050 "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	3051 "backup" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3052 "weight" : 5,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3053 "state" : "up",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3054 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3055 "max_conns" : 50,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3056 "connections" : 667231,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3057 "sent" : 251946292,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3058 "received" : 19222475454,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3059 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3060 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3061 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3062 "checks" : 26214,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3063 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3064 "unhealthy" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3065 "last_passed" : true
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3066 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3067 "downtime" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3068 "downstart" : "2017-07-07T11:09:21.602Z",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3069 "selected" : "2017-07-17T15:01:25.000Z"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3070 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3071 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3072 "id" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3073 "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	3074 "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	3075 "backup" : true,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3076 "weight" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3077 "state" : "unhealthy",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3078 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3079 "max_conns" : 50,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3080 "connections" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3081 "sent" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3082 "received" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3083 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3084 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3085 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3086 "checks" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3087 "fails" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3088 "unhealthy" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3089 "last_passed" : false
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3090 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3091 "downtime" : 262925617,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3092 "downstart" : "2017-07-07T11:09:21.602Z",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3093 "selected" : "2017-07-17T15:01:25.000Z"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3094 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3095 ],
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3096 "zombies" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3097 "zone" : "dns"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3098 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3099 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3100 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3101 <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	3102 <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	3103 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	3104 <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	3105 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3106 <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	3107 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3108 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3109 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	3110 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3111 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3112 <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	3113 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3114 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3115 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	3116 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3117 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3118 <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	3119 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3120 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3121 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	3122 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3123 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3124 <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	3125 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3126 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3127 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	3128 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3129 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3130 <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	3131 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3132 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3133 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	3134 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3135 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3136 <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	3137 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3138 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3139 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	3140 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3141 <tag-name>
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3142 <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	3143 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3144 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3145 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	3146 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3147 <tag-name>
2133 bb3d2ce5192e Changed type of fail_timeout and slow_start in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2132 diff changeset	3148 <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	3149 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3150 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3151 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	3152 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3153 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3154 <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	3155 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3156 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3157 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	3158 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3159 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3160 <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	3161 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3162 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3163 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	3164 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3165 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3166 <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	3167 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3168 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3169 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	3170 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3171 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3172 <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	3173 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3174 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3175 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	3176 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3177 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3178 <para>Example:</para>
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 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3181 "id" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3182 "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	3183 "weight" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3184 "max_conns" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3185 "max_fails" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3186 "fail_timeout" : "10s",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3187 "slow_start" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3188 "backup" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3189 "down" : false
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3190 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3191 </listitem>
2082 fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3192 <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	3193 <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	3194 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	3195 <example>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3196 {
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3197 "key1" : "value1",
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3198 "key2" : "value2",
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3199 "key3" : "value3"
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3200 }</example>
fee7627f6a5a Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2072 diff changeset	3201 </listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3202 <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	3203 <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	3204 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	3205 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	3206 <example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3207 {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3208 "key1" : "value1",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3209 "key2" : "value2",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3210 "key3" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3211 "value" : "value3",
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3212 "expire" : 30000
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3213 }
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3214 }</example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3215 </listitem>
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3216 <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	3217 <para>Stream Zone Sync Node:</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3218 <list type="tag">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3219 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3220 <literal>zones</literal></tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3221 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3222 <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	3223 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3224 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3225 <literal>status</literal></tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3226 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3227 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	3228 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3229 <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	3230 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3231 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3232 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	3233 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3234 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3235 <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	3236 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3237 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3238 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	3239 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3240 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3241 <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	3242 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3243 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3244 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	3245 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3246 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3247 <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	3248 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3249 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3250 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	3251 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3252 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3253 <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	3254 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3255 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3256 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	3257 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3258 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3259 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3260 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3261 <para>Example:</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3262 <example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3263 {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3264 "zones" : {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3265 "zone1" : {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3266 "records_pending" : 2061,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3267 "records_total" : 260575
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3268 },
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3269 "zone2" : {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3270 "records_pending" : 0,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3271 "records_total" : 14749
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3272 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3273 },
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3274 "status" : {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3275 "bytes_in" : 1364923761,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3276 "msgs_in" : 337236,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3277 "msgs_out" : 346717,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3278 "bytes_out" : 1402765472,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3279 "nodes_online" : 15
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3280 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3281 }</example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3282 </listitem>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3283 <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	3284 <para>Sync Zone:</para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3285 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	3286 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3287 <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	3288 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3289 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3290 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	3291 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3292 <tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3293 <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	3294 </tag-name>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3295 <tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3296 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	3297 </tag-desc>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3298 </list>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2133 diff changeset	3299 </listitem>
2424 dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3300 <listitem id="def_nginx_resolver_zone">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3301 <para>Resolver Zone:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3302 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	3303 <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	3304 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3305 <literal>requests</literal></tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3306 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3307 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3308 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3309 <literal>name</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3310 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3311 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3312 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	3313 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3314 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3315 <literal>srv</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3316 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3317 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3318 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	3319 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3320 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3321 <literal>addr</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3322 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3323 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3324 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	3325 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3326 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3327 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3328 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3329 <literal>responses</literal></tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3330 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3331 <list type="tag">
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3332 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3333 <literal>noerror</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3334 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3335 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3336 The total number of successful responses.
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3337 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3338 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3339 <literal>formerr</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3340 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3341 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3342 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	3343 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3344 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3345 <literal>servfail</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3346 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3347 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3348 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	3349 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3350 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3351 <literal>nxdomain</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3352 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3353 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3354 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	3355 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3356 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3357 <literal>notimp</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3358 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3359 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3360 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	3361 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3362 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3363 <literal>refused</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3364 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3365 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3366 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	3367 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3368 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3369 <literal>timedout</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3370 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3371 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3372 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	3373 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3374 <tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3375 <literal>unknown</literal> (<literal>integer</literal>)
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3376 </tag-name>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3377 <tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3378 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	3379 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3380 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3381 </tag-desc>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3382 </list>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3383 <para>Example:</para>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3384 <example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3385 {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3386 "resolver_zone1" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3387 "requests" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3388 "name" : 25460,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3389 "srv" : 130,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3390 "addr" : 2580
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3391 },
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3392 "responses" : {
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3393 "noerror" : 26499,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3394 "formerr" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3395 "servfail" : 3,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3396 "nxdomain" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3397 "notimp" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3398 "refused" : 0,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3399 "timedout" : 243,
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3400 "unknown" : 478
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3401 }
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3402 }
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3403 }</example>
dd3ac7eefeed Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2359 diff changeset	3404 </listitem>
2034 7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3405 <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	3406 <para>Error:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3407 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	3408 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3409 <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	3410 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3411 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3412 <tag-name>
2132 a645aa9f2ebf Changed type of HTTP error code to integer in API. Yaroslav Zhuravlev <yar@nginx.com> parents: 2082 diff changeset	3413 <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	3414 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3415 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3416 HTTP error code.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3417 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3418 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3419 <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	3420 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3421 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3422 Error description.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3423 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3424 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3425 <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	3426 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3427 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3428 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	3429 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3430 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3431 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3432 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3433 <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	3434 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3435 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	3436 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	3437 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3438 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3439 <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	3440 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3441 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3442 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	3443 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3444 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3445 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3446 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3447 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3448 </section>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3449
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	3450 </module>

Mercurial > hg > nginx-site

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