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

annotate xml/en/docs/http/ngx_http_api_module.xml @ 2133:bb3d2ce5192e

Changed type of fail_timeout and slow_start in API.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Thu, 05 Apr 2018 15:49:33 +0300
parents	a645aa9f2ebf
children	f6e578b1b02d

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

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_api_module.xml @ 2133:bb3d2ce5192e