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

annotate xml/en/docs/http/ngx_http_api_module.xml @ 2046:a810103f8a75

Changed summary and description style to flow scalar in yaml.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Wed, 27 Sep 2017 21:55:34 +0300
parents	7e7edf832099
children	593dfdc524ae

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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	100 All API requests include 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	101 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	102 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	103 http://127.0.0.1/api/1/
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	104 http://127.0.0.1/api/1/nginx
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	105 http://127.0.0.1/api/1/connections
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	106 http://127.0.0.1/api/1/http/requests
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	107 http://127.0.0.1/api/1/http/server_zones/server_backend
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	108 http://127.0.0.1/api/1/http/caches/cache_backend
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	109 http://127.0.0.1/api/1/http/upstreams/backend
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	110 http://127.0.0.1/api/1/http/upstreams/backend/servers/
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	111 http://127.0.0.1/api/1/http/upstreams/backend/servers/1
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	112 http://127.0.0.1/api/1/http/keyvals/one?key=arg1
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	113 http://127.0.0.1/api/1/stream/
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	114 http://127.0.0.1/api/1/stream/server_zones/server_backend
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	115 http://127.0.0.1/api/1/stream/upstreams/
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	116 http://127.0.0.1/api/1/stream/upstreams/backend
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	117 http://127.0.0.1/api/1/stream/upstreams/backend/servers/1
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	118 </example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	119 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	120
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	121 </section>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	122
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 <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	125
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	126 <directive name="api">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	127 <syntax>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	128 [<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	129 <default/>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	130 <context>location</context>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	131
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	132 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	133 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	134 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	135 <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	136 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	137
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	138 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	139 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	140 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	141 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	142 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	143
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	144 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	145 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	146 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	147 the list of supported API versions is returned.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	148 The current and the only API version is “<literal>1</literal>”.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	149 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	150
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	151 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	152 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	153 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	154 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	155 http://127.0.0.1/api/1/nginx?fields=version,build
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	156 </example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	157 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	158
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	159 </directive>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	160
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	161 </section>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	162 <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	163 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	164 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	165 <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	166 <literal>/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	167 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	168 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	169 <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	170 <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	171 <listitem id="getAPIEndpoints">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	172 <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	173 <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	174 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	175 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	176 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	177 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	178 <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	179 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	180 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	181 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	182 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	183 <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	184 <literal>/nginx</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	185 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	186 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	187 <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	188 <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	189 <listitem id="getNginx">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	190 <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	191 <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	192 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	193 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	194 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	195 <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	196 (<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	197 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	198 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	199 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	200 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	201 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	202 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	203 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	204 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	205 <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	206 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	207 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	208 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	209 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	210 <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	211 <literal>/processes</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	212 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	213 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	214 <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	215 <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	216 <listitem id="getProcesses">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	217 <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	218 <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	219 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	220 Possible responses:
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 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	223 <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	224 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	225 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	226 <listitem id="deleteProcesses">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	227 <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	228 <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	229 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	230 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	231 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	232 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	233 <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	234 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	235 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	236 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	237 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	238 <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	239 <literal>/connections</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	240 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	241 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	242 <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	243 <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	244 <listitem id="getConnections">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	245 <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	246 <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	247 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	248 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	249 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	250 <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	251 (<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	252 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	253 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	254 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	255 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	256 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	257 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	258 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	259 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	260 <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	261 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	262 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	263 <listitem id="deleteConnections">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	264 <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	265 <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	266 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	267 Possible responses:
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 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	270 <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	271 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	272 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	273 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	274 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	275 <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	276 <literal>/ssl</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	277 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	278 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	279 <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	280 <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	281 <listitem id="getSsl">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	282 <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	283 <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	284 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	285 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	286 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	287 <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	288 (<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	289 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	290 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	291 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	292 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	293 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	294 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	295 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	296 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	297 <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	298 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	299 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	300 <listitem id="deleteSslStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	301 <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	302 <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	303 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	304 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	305 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	306 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	307 <listitem>204 - Success</listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	308 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	309 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	310 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	311 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	312 <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	313 <literal>/slabs/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	314 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	315 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	316 <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	317 <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	318 <listitem id="getSlabs">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	319 <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	320 <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	321 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	322 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	323 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	324 <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	325 (<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	326 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	327 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	328 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	329 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	330 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	331 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	332 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	333 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	334 <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	335 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	336 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	337 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	338 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	339 <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	340 <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	341 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	342 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	343 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	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>slabZoneName</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>, required)</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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	348 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	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>Supported methods:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	351 <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	352 <listitem id="getSlabZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	353 <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	354 <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	355 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	356 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	357 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	358 <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	359 (<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	360 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	361 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	362 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	363 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	364 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	365 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	366 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	367 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	368 <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	369 <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	370 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	371 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	372 <listitem id="deleteSlabZoneStats">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	373 <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	374 <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	375 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	376 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	377 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	378 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	379 <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	380 <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	381 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	382 </listitem>
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 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	385 <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	386 <literal>/http/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	387 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	388 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	389 <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	390 <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	391 <listitem id="getHttp">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	392 <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	393 <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	394 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	395 Possible responses:
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 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	398 <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	399 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	400 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	401 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	402 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	403 <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	404 <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	405 </tag-name>
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 <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	408 <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	409 <listitem id="getHttpRequests">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	410 <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	411 <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	412 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	413 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	414 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	415 <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	416 (<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	417 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	418 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	419 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	420 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	421 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	422 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	423 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	424 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	425 <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	426 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	427 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	428 <listitem id="deleteHttpRequests">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	429 <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	430 <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	431 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	432 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	433 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	434 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	435 <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	436 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	437 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	438 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	439 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	440 <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	441 <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	442 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	443 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	444 <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	445 <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	446 <listitem id="getHttpServerZones">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	447 <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	448 <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	449 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	450 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	451 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	452 <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	453 (<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	454 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	455 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	456 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	457 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	458 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	459 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	460 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	461 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	462 <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	463 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	464 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	465 </list>
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 <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	468 <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	469 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	470 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	471 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	472 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	473 <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	474 (<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	475 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	476 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	477 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	478 <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	479 <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	480 <listitem id="getHttpServerZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	481 <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	482 <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	483 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	484 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	485 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	486 <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	487 (<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	488 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	489 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	490 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	491 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	492 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	493 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	494 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	495 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	496 <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	497 <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	498 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	499 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	500 <listitem id="deleteHttpServerZoneStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	501 <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	502 <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	503 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	504 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	505 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	506 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	507 <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	508 <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	509 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	510 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	511 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	512 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	513 <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	514 <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	515 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	516 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	517 <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	518 <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	519 <listitem id="getHttpCaches">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	520 <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	521 <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	522 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	523 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	524 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	525 <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	526 (<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	527 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	528 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	529 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	530 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	531 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	532 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	533 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	534 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	535 <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	536 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	537 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	538 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	539 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	540 <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	541 <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	542 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	543 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	544 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	545 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	546 <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	547 (<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	548 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	549 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	550 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	551 <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	552 <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	553 <listitem id="getHttpCacheZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	554 <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	555 <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	556 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	557 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	558 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	559 <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	560 (<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	561 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	562 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	563 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	564 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	565 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	566 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	567 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	568 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	569 <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	570 <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	571 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	572 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	573 <listitem id="deleteHttpCacheZoneStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	574 <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	575 <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	576 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	577 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	578 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	579 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	580 <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	581 <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	582 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	583 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	584 </list>
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 <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	587 <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	588 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	589 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	590 <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	591 <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	592 <listitem id="getHttpUpstreams">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	593 <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	594 <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	595 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	596 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	597 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	598 <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	599 (<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	600 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	601 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	602 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	603 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	604 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	605 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	606 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	607 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	608 <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	609 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	610 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	611 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	612 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	613 <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	614 <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	615 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	616 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	617 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	618 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	619 <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	620 (<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	621 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	622 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	623 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	624 <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	625 <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	626 <listitem id="getHttpUpstreamName">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	627 <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	628 <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	629 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	630 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	631 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	632 <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	633 (<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	634 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	635 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	636 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	637 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	638 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	639 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	640 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	641 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	642 <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	643 <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	644 <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	645 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	646 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	647 <listitem id="deleteHttpUpstreamStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	648 <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	649 <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	650 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	651 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	652 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	653 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	654 <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	655 <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	656 <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	657 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	658 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	659 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	660 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	661 <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	662 <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	663 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	664 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	665 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	666 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	667 <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	668 (<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	669 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	670 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	671 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	672 <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	673 <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	674 <listitem id="getHttpUpstreamServers">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	675 <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	676 <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	677 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	678 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	679 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	680 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	681 <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	682 <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	683 <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	684 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	685 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	686 <listitem id="postHttpUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	687 <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	688 <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	689 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	690 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	691 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	692 <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	693 (<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	694 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	695 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	696 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	697 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	698 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	699 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	700 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	701 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	702 <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	703 <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	704 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	705 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	706 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	707 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	708 “<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	709 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	710 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	711 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	712 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	713 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	714 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	715 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	716 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	717 “<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	718 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	719 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	720 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	721 <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	722 <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	723 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	724 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	725 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	726 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	727 <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	728 <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	729 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	730 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	731 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	732 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	733 <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	734 (<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	735 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	736 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	737 <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	738 (<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	739 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	740 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	741 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	742 <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	743 <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	744 <listitem id="getHttpUpstreamPeer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	745 <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	746 <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	747 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	748 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	749 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	750 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	751 <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	752 <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	753 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	754 <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	755 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	756 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	757 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	758 <listitem id="patchHttpUpstreamPeer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	759 <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	760 <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	761 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	762 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	763 <list type="tag">
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>patchHttpUpstreamServer</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	765 (<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	766 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	767 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	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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	770 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	771 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	772 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	773 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	774 <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	775 <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	776 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	777 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	778 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	779 “<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	780 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	781 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	782 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	783 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	784 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	785 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	786 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	787 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	788 “<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	789 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	790 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	791 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	792 <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	793 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	794 <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	795 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	796 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	797 <listitem id="deleteHttpUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	798 <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	799 <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	800 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	801 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	802 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	803 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	804 <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	805 <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	806 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	807 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	808 <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	809 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	810 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	811 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	812 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	813 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	814 <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	815 <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	816 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	817 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	818 <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	819 <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	820 <listitem id="getHttpKeyvalZones">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	821 <literal>GET</literal> - Return key-value pairs from all keyval zones
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	822 <para>Returns key-value pairs for each 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	823 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	824 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	825 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	826 <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	827 (<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	828 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	829 If the “<literal>fields</literal>” value is empty, then only 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	830 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	831 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	832 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	833 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	834 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	835 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	836 <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</link>" objects for all http keyvals </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	837 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	838 </listitem>
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 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	841 <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	842 <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	843 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	844 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	845 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	846 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	847 <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	848 (<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	849 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	850 The name of a keyval shared memory zone.</tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	851 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	852 <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	853 <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	854 <listitem id="getHttpKeyvalZoneKeysValues">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	855 <literal>GET</literal> - Return key-value pairs from a keyval zone
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	856 <para>Returns key-value pairs stored in a particular 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	857 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	858 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	859 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	860 <tag-name><literal>key</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	861 (<literal>string</literal>, optional)</tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	862 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	863 Get a particular key-value pair from the keyval zone.</tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	864 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	865 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	866 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	867 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	868 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	869 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	870 <listitem>200 - Success, returns <link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</link></listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	871 <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	872 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	873 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	874 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	875 <listitem id="postHttpKeyvalZoneData">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	876 <literal>POST</literal> - Add a key-value pair to the keyval zone
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	877 <para>Adds a new key-value pair to the 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 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	878 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	879 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	880 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	881 <tag-name><literal>Key-value</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	882 (<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</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	883 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	884 A key-value pair is specified in the JSON format. Several key-value pairs can be entered if the 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	885 </list>
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 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	888 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	889 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	890 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	891 <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	892 <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	893 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	894 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	895 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</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	896 <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	897 <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	898 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	899 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	900 <listitem id="patchHttpKeyvalZoneKeyValue">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	901 <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	902 <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	903 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	904 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	905 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	906 <tag-name><literal>httpKeyvalZoneKeyValue</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	907 (<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</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	908 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	909 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	910 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	911 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	912 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	913 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	914 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	915 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	916 <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	917 <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	918 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	919 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	920 <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	921 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	922 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	923 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	924 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	925 <listitem id="deleteHttpKeyvalZoneData">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	926 <literal>DELETE</literal> - Empty the keyval zone
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	927 <para>Deletes all key-value pairs from the 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	928 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	929 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	930 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	931 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	932 <listitem>204 - Success</listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	933 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</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	934 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	935 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	936 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	937 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	938 <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	939 <literal>/stream/</literal>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	940 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	941 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	942 <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	943 <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	944 <listitem id="getStream">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	945 <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	946 <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	947 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	948 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	949 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	950 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	951 <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	952 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	953 </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 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	956 <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	957 <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	958 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	959 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	960 <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	961 <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	962 <listitem id="getStreamServerZones">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	963 <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	964 <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	965 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	966 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	967 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	968 <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	969 (<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	970 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	971 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	972 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	973 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	974 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	975 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	976 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	977 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	978 <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	979 <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	980 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	981 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	982 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	983 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	984 <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	985 <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	986 </tag-name>
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 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	989 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	990 <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	991 (<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	992 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	993 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	994 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	995 <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	996 <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	997 <listitem id="getStreamServerZone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	998 <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	999 <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	1000 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1001 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1002 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1003 <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	1004 (<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	1005 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1006 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	1007 </list>
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 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1010 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1011 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1012 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1013 <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	1014 <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	1015 <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	1016 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1017 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1018 <listitem id="deleteStreamServerZoneStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1019 <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	1020 <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	1021 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1022 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1023 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1024 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1025 <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	1026 <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	1027 <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	1028 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1029 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1030 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1031 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1032 <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	1033 <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	1034 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1035 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1036 <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	1037 <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	1038 <listitem id="getStreamUpstreams">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1039 <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	1040 <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	1041 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1042 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1043 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1044 <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	1045 (<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	1046 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1047 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	1048 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1049 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1050 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1051 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1052 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1053 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1054 <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	1055 <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	1056 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1057 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1058 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1059 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1060 <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	1061 <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	1062 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1063 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1064 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	1065 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1066 <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	1067 (<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	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 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	1070 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1071 <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	1072 <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	1073 <listitem id="getStreamUpstream">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1074 <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	1075 <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	1076 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1077 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1078 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1079 <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	1080 (<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	1081 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1082 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	1083 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1084 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1085 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1086 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1087 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1088 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1089 <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	1090 <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	1091 <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	1092 <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	1093 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1094 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1095 <listitem id="deleteStreamUpstreamStat">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1096 <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	1097 <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	1098 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1099 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1100 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1101 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1102 <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	1103 <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	1104 <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	1105 <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	1106 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1107 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1108 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1109 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1110 <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	1111 <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	1112 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1113 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1114 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	1115 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1116 <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	1117 (<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	1118 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1119 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	1120 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1121 <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	1122 <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	1123 <listitem id="getStreamUpstreamServers">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1124 <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	1125 <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	1126 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1127 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1128 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1129 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1130 <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	1131 <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	1132 <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	1133 <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	1134 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1135 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1136 <listitem id="postStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1137 <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	1138 <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	1139 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1140 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1141 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1142 <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	1143 (<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	1144 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1145 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	1146 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1147 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1148 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1149 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1150 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1151 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1152 <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	1153 <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	1154 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	1155 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	1156 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	1157 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	1158 “<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	1159 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	1160 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	1161 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	1162 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	1163 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	1164 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	1165 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	1166 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	1167 “<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	1168 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	1169 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	1170 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	1171 <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	1172 <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	1173 <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	1174 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1175 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1176 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1177 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1178 <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	1179 <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	1180 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1181 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1182 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	1183 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1184 <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	1185 (<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	1186 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1187 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	1188 <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	1189 (<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	1190 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1191 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	1192 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1193 <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	1194 <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	1195 <listitem id="getStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1196 <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	1197 <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	1198 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1199 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1200 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1201 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1202 <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	1203 <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	1204 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	1205 <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	1206 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	1207 <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	1208 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1209 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1210 <listitem id="patchStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1211 <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	1212 <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	1213 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1214 Request parameters:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1215 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1216 <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	1217 (<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	1218 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1219 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	1220 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1221 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1222 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1223 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1224 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1225 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1226 <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	1227 <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	1228 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	1229 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	1230 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	1231 “<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	1232 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	1233 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	1234 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	1235 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	1236 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	1237 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	1238 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	1239 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	1240 “<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	1241 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	1242 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	1243 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	1244 <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	1245 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	1246 <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	1247 <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	1248 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1249 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1250 <listitem id="deleteStreamUpstreamServer">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1251 <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	1252 <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	1253 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1254 Possible responses:
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1255 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1256 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1257 <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	1258 <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	1259 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	1260 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	1261 <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	1262 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	1263 <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	1264 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1265 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1266 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1267 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1268 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1269 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1270 </section>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1271 <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	1272 <para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1273 <list type="bullet">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1274 <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	1275 <para>nginx:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1276 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	1277 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1278 <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	1279 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1280 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1281 Version of nginx.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1282 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1283 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1284 <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	1285 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1286 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1287 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	1288 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1289 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1290 <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	1291 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1292 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1293 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	1294 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1295 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1296 <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	1297 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1298 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1299 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	1300 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1301 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1302 <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	1303 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1304 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1305 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	1306 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1307 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1308 <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	1309 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1310 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1311 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	1312 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1313 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1314 <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	1315 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1316 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1317 The 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	1318 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1319 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1320 <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	1321 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1322 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1323 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	1324 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1325 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1326 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1327 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1328 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1329 "nginx" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1330 "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	1331 "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	1332 "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	1333 "generation" : 2,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1334 "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	1335 "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	1336 "pid" : 32212,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1337 "ppid" : 32210
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1338 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1339 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1340 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1341 <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	1342 <para>Processes:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1343 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1344 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1345 <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	1346 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1347 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1348 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	1349 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1350 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1351 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1352 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1353 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1354 "respawned" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1355 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1356 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1357 <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	1358 <para>Connections:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1359 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	1360 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1361 <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	1362 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1363 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1364 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	1365 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1366 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1367 <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	1368 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1369 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1370 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	1371 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1372 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1373 <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	1374 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1375 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1376 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	1377 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1378 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1379 <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	1380 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1381 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1382 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	1383 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1384 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1385 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1386 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1387 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1388 "accepted" : 4968119,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1389 "dropped" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1390 "active" : 5,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1391 "idle" : 117
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1392 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1393 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1394 <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	1395 <para>SSL:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1396 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1397 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1398 <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	1399 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1400 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1401 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	1402 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1403 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1404 <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	1405 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1406 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1407 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	1408 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1409 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1410 <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	1411 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1412 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1413 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	1414 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1415 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1416 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1417 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1418 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1419 "handshakes" : 79572,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1420 "handshakes_failed" : 21025,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1421 "session_reuses" : 15762
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1422 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1423 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1424 <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	1425 <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	1426 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1427 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1428 <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	1429 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1430 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	1431 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1432 <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	1433 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1434 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1435 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	1436 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1437 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1438 <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	1439 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1440 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1441 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	1442 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1443 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1444 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1445 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1446 <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	1447 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1448 <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	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 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1451 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1452 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1453 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1454 "pages" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1455 "used" : 1143,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1456 "free" : 2928
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1457 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1458 "slots" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1459 "8" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1460 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1461 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1462 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1463 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1464 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1465 "16" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1466 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1467 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1468 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1469 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1470 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1471 "32" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1472 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1473 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1474 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1475 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1476 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1477 "64" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1478 "used" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1479 "free" : 63,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1480 "reqs" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1481 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1482 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1483 "128" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1484 "used" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1485 "free" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1486 "reqs" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1487 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1488 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1489 "256" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1490 "used" : 18078,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1491 "free" : 178,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1492 "reqs" : 1635736,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1493 "fails" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1494 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1495 }
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 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1498 <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	1499 <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	1500 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1501 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1502 <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	1503 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1504 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1505 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	1506 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1507 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1508 <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	1509 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1510 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1511 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	1512 </tag-desc>
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>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	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 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1520 <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	1521 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1522 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1523 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	1524 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1525 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1526 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1527 <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	1528 <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	1529 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1530 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1531 <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	1532 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1533 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1534 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	1535 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1536 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1537 <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	1538 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1539 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1540 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	1541 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1542 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1543 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1544 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1545 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1546 "total" : 10624511,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1547 "current" : 4
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1548 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1549 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1550 <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	1551 <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	1552 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1553 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1554 <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	1555 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1556 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1557 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	1558 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1559 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1560 <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	1561 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1562 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1563 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	1564 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1565 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1566 <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	1567 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1568 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	1569 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1570 <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	1571 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1572 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1573 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	1574 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1575 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1576 <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	1577 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1578 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1579 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	1580 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1581 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1582 <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	1583 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1584 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1585 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	1586 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1587 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1588 <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	1589 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1590 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1591 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	1592 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1593 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1594 <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	1595 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1596 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1597 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1600 <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	1601 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1602 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1603 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	1604 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1605 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1606 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1607 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1608 <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	1609 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1610 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1611 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	1612 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1613 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1614 <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	1615 </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 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1620 <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	1621 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1622 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1623 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	1624 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1625 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1626 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1627 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1628 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1629 "processing" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1630 "requests" : 706690,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1631 "responses" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1632 "1xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1633 "2xx" : 699482,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1634 "3xx" : 4522,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1635 "4xx" : 907,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1636 "5xx" : 266,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1637 "total" : 705177
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1638 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1639 "discarded" : 1513,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1640 "received" : 172711587,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1641 "sent" : 19415530115
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1642 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1643 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1644 <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	1645 <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	1646 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1647 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1648 <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	1649 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1650 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1651 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	1652 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1653 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1654 <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	1655 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1656 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1657 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	1658 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1659 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1660 <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	1661 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1662 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1663 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	1664 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1665 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1666 <literal>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	1667 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1668 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1669 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1670 <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	1671 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1672 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1673 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	1674 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1675 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1676 <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	1677 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1678 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1679 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	1680 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1681 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1682 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1683 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1684 <literal>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	1685 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1686 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1687 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1688 <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	1689 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1690 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1691 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	1692 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1693 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1694 <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	1695 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1696 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1697 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	1698 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1699 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1700 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1701 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1702 <literal>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	1703 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1704 <list type="tag">
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>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	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>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1709 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1712 <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	1713 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1714 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1715 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	1716 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1717 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1718 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1719 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1720 <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	1721 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1722 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1723 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1724 <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	1725 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1726 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1727 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	1728 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1729 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1730 <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	1731 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1732 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1733 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	1734 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1735 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1736 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1737 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1738 <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	1739 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1740 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1741 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1742 <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	1743 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1744 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1745 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	1746 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1747 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1748 <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	1749 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1750 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1751 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	1752 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1753 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1754 <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	1755 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1756 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1757 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	1758 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1759 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1760 <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	1761 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1762 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1763 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	1764 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1765 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1766 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1767 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1768 <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	1769 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1770 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1771 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1772 <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	1773 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1774 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1775 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	1776 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1777 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1778 <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	1779 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1780 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1781 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	1782 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1783 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1784 <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	1785 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1786 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1787 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	1788 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1789 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1790 <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	1791 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1792 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1793 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	1794 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1795 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1796 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1797 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1798 <literal>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	1799 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1800 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1801 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1802 <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	1803 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1804 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1805 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	1806 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1807 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1808 <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	1809 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1810 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1811 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	1812 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1813 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1814 <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	1815 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1816 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1817 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	1818 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1819 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1820 <literal>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	1821 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1822 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1823 The 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	1824 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1825 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1826 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1827 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1828 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1829 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1830 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1831 "size" : 530915328,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1832 "max_size" : 536870912,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1833 "cold" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1834 "hit" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1835 "responses" : 254032,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1836 "bytes" : 6685627875
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1837 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1838 "stale" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1839 "responses" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1840 "bytes" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1841 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1842 "updating" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1843 "responses" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1844 "bytes" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1845 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1846 "revalidated" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1847 "responses" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1848 "bytes" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1849 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1850 "miss" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1851 "responses" : 1619201,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1852 "bytes" : 53841943822
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1853 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1854 "expired" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1855 "responses" : 45859,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1856 "bytes" : 1656847080,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1857 "responses_written" : 44992,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1858 "bytes_written" : 1641825173
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1859 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1860 "bypass" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1861 "responses" : 200187,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1862 "bytes" : 5510647548,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1863 "responses_written" : 200173,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1864 "bytes_written" : 44992
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1865 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1866 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1867 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1868 <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	1869 <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	1870 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1871 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1872 <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	1873 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1874 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	1875 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1876 <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	1877 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1878 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1879 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	1880 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1881 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1882 <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	1883 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1884 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1885 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	1886 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1887 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1888 <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	1889 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1890 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1891 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	1892 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1893 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1894 <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	1895 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1896 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1897 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	1898 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1899 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1900 <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	1901 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1902 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1903 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	1904 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1905 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1906 <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	1907 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1908 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1909 <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	1910 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1911 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1912 <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	1913 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1914 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1915 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	1916 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1917 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1918 <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	1919 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1920 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1921 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	1922 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1923 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1924 <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	1925 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1926 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1927 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	1928 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1929 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1930 <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	1931 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1932 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1933 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	1934 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1935 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1936 <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	1937 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1938 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1939 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1940 <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	1941 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1942 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1943 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	1944 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1945 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1946 <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	1947 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1948 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1949 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	1950 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1951 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1952 <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	1953 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1954 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1955 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	1956 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1957 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1958 <literal>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	1959 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1960 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1961 The number of responses with “<literal>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	1962 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1963 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1964 <literal>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	1965 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1966 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1967 The number of responses with “<literal>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	1968 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1969 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1970 <literal>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	1971 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1972 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1973 The 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	1974 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1975 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1976 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1977 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1978 <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	1979 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1980 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1981 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	1982 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1983 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1984 <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	1985 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1986 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1987 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	1988 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1989 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1990 <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	1991 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1992 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1993 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	1994 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1995 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1996 <literal>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	1997 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	1998 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	1999 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	2000 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2001 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2002 <literal>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	2003 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2004 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2005 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2006 <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	2007 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2008 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2009 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	2010 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2011 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2012 <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	2013 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2014 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2015 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	2016 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2017 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2018 <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	2019 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2020 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2021 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	2022 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2023 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2024 <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	2025 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2026 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2027 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	2028 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2029 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2030 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2031 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2032 <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	2033 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2034 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2035 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	2036 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2037 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2038 <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	2039 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2040 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2041 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2044 <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	2045 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2046 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2047 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	2048 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2049 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2050 <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	2051 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2052 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2053 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	2054 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2055 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2056 <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	2057 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2058 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2059 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	2060 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2061 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2062 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2063 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2064 <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	2065 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2066 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2067 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	2068 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2069 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2070 <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	2071 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2072 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2073 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	2074 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2075 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2076 <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	2077 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2078 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2079 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	2080 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2081 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2082 <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	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 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	2085 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2086 <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	2087 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2088 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2089 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	2090 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2091 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2092 <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	2093 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2094 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2095 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	2096 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2097 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2098 <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	2099 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2100 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2101 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	2102 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2103 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2104 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2105 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2106 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2107 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2108 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2109 "upstream_backend" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2110 "peers" : [
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2111 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2112 "id" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2113 "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	2114 "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	2115 "backup" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2116 "weight" : 5,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2117 "state" : "up",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2118 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2119 "max_conns" : 20,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2120 "requests" : 667231,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2121 "header_time" : 20,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2122 "response_time" : 36,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2123 "responses" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2124 "1xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2125 "2xx" : 666310,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2126 "3xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2127 "4xx" : 915,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2128 "5xx" : 6,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2129 "total" : 667231
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2130 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2131 "sent" : 251946292,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2132 "received" : 19222475454,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2133 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2134 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2135 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2136 "checks" : 26214,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2137 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2138 "unhealthy" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2139 "last_passed" : true
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2140 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2141 "downtime" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2142 "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	2143 "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	2144 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2145 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2146 "id" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2147 "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	2148 "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	2149 "backup" : true,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2150 "weight" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2151 "state" : "unhealthy",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2152 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2153 "max_conns" : 20,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2154 "requests" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2155 "responses" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2156 "1xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2157 "2xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2158 "3xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2159 "4xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2160 "5xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2161 "total" : 0
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2162 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2163 "sent" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2164 "received" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2165 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2166 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2167 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2168 "checks" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2169 "fails" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2170 "unhealthy" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2171 "last_passed" : false
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2172 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2173 "downtime" : 262925617,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2174 "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	2175 "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	2176 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2177 ],
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2178 "keepalive" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2179 "zombies" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2180 "zone" : "upstream_backend"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2181 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2182 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2183 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2184 <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	2185 <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	2186 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	2187 <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	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 <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	2190 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2191 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2192 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	2193 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2194 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2195 <literal>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	2196 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2197 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2198 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	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>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	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 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	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>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	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 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	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>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	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 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	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>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	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 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	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>fail_timeout</literal> (<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 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	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 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2231 <literal>slow_start</literal> (<literal>integer</literal>)
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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2234 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	2235 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2236 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2237 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2240 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	2241 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2242 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2243 <literal>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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2246 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	2247 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2248 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2249 <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	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 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2252 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	2253 </tag-desc>
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>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	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>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2258 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	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>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	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 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	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>drain</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	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>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2270 Puts the HTTP upstream server into the “draining” mode. In this mode, only requests <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#sticky">bound</link> to the server will be proxied to it. The parameter cannot be initially set, it can only be changed with the <literal>PATCH</literal> method.
2034 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 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2274 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2275 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2276 "id" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2277 "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	2278 "weight" : 4,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2279 "max_conns" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2280 "max_fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2281 "fail_timeout" : "10s",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2282 "slow_start" : "10s",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2283 "route" : "",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2284 "backup" : true,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2285 "down" : true
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2286 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2287 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2288 <listitem id="def_nginx_http_keyval_zone">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2289 <para>Keyval Shared Memory Zone:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2290 Contents of a keyval shared memory zone.<para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2291 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2292 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2293 "key1" : "value1",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2294 "key2" : "value2",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2295 "key3" : "value3"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2296 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2297 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2298 <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	2299 <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	2300 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2301 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2302 <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	2303 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2304 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2305 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	2306 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2307 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2308 <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	2309 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2310 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2311 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	2312 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2313 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2314 <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	2315 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2316 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	2317 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2318 <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	2319 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2320 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2321 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	2322 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2323 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2324 <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	2325 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2326 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2327 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	2328 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2329 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2330 <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	2331 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2332 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2333 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	2334 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2335 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2336 <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	2337 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2338 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2339 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	2340 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2341 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2342 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2343 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2344 <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	2345 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2346 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2347 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	2348 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2349 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2350 <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	2351 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2352 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2353 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	2354 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2355 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2356 <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	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 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2359 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	2360 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2361 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2362 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2363 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2364 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2365 "dns" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2366 "processing" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2367 "connections" : 155569,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2368 "sessions" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2369 "2xx" : 155564,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2370 "4xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2371 "5xx" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2372 "total" : 155569
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2373 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2374 "discarded" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2375 "received" : 4200363,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2376 "sent" : 20489184
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2377 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2378 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2379 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2380 <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	2381 <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	2382 <list type="tag">
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 <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	2385 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2386 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	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>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	2389 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2390 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2391 The 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	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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2394 <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	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 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	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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2400 <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	2401 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2402 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2403 The <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	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>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	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 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	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 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	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>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	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 <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	2422 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2423 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2424 <literal>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	2425 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2426 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2427 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	2428 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2429 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2430 <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	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>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2433 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	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>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	2437 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2438 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2439 The <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	2440 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2441 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2442 <literal>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	2443 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2444 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2445 The total number of 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	2446 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2447 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2448 <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	2449 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2450 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2451 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	2452 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2453 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2454 <literal>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	2455 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2456 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2457 The 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	2458 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2459 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2460 <literal>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	2461 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2462 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2463 The 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	2464 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2465 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2466 <literal>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	2467 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2468 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2469 The total number of 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	2470 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2471 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2472 <literal>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	2473 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2474 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2475 The total number of bytes 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	2476 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2477 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2478 <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	2479 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2480 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2481 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	2482 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2483 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2484 <literal>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	2485 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2486 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2487 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	2488 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2489 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2490 <literal>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	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 <list type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2493 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2494 <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	2495 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2496 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2497 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	2498 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2499 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2500 <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	2501 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2502 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2503 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	2504 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2505 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2506 <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	2507 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2508 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2509 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	2510 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2511 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2512 <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	2513 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2514 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2515 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	2516 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2517 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2518 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2519 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2520 <literal>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	2521 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2522 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2523 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	2524 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2525 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2526 <literal>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	2527 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2528 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2529 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	2530 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2531 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2532 <literal>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	2533 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2534 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2535 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	2536 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2537 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2538 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2539 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2540 <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	2541 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2542 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2543 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	2544 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2545 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2546 <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	2547 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2548 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2549 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	2550 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2551 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2552 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2553 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2554 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2555 "dns" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2556 "peers" : [
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2557 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2558 "id" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2559 "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	2560 "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	2561 "backup" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2562 "weight" : 5,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2563 "state" : "up",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2564 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2565 "max_conns" : 50,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2566 "connections" : 667231,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2567 "sent" : 251946292,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2568 "received" : 19222475454,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2569 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2570 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2571 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2572 "checks" : 26214,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2573 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2574 "unhealthy" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2575 "last_passed" : true
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2576 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2577 "downtime" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2578 "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	2579 "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	2580 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2581 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2582 "id" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2583 "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	2584 "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	2585 "backup" : true,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2586 "weight" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2587 "state" : "unhealthy",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2588 "active" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2589 "max_conns" : 50,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2590 "connections" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2591 "sent" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2592 "received" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2593 "fails" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2594 "unavail" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2595 "health_checks" : {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2596 "checks" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2597 "fails" : 26284,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2598 "unhealthy" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2599 "last_passed" : false
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2600 },
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2601 "downtime" : 262925617,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2602 "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	2603 "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	2604 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2605 ],
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2606 "zombies" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2607 "zone" : "dns"
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2608 }
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2609 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2610 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2611 <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	2612 <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	2613 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	2614 <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	2615 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2616 <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	2617 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2618 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2619 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	2620 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2621 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2622 <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	2623 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2624 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2625 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	2626 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2627 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2628 <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	2629 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2630 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2631 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	2632 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2633 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2634 <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	2635 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2636 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2637 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	2638 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2639 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2640 <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	2641 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2642 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2643 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	2644 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2645 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2646 <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	2647 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2648 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2649 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	2650 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2651 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2652 <literal>fail_timeout</literal> (<literal>integer</literal>)
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2653 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2654 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2655 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	2656 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2657 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2658 <literal>slow_start</literal> (<literal>integer</literal>)
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2659 </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>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2661 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	2662 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2663 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2664 <literal>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	2665 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2666 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2667 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	2668 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2669 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2670 <literal>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	2671 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2672 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2673 Same as the <link url="https://nginx.org/en/docs/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	2674 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2675 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2676 <literal>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	2677 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2678 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2679 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	2680 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2681 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2682 <literal>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	2683 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2684 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2685 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	2686 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2687 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2688 <para>Example:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2689 <example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2690 {
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2691 "id" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2692 "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	2693 "weight" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2694 "max_conns" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2695 "max_fails" : 1,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2696 "fail_timeout" : "10s",
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2697 "slow_start" : 0,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2698 "backup" : false,
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2699 "down" : false
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2700 }</example>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2701 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2702 <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	2703 <para>Error:</para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2704 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	2705 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2706 <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	2707 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2708 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2709 API path.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2710 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2711 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2712 <literal>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	2713 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2714 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2715 HTTP method.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2716 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2717 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2718 <literal>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	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 type="tag">
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2721 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2722 <literal>status</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	2723 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2724 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2725 HTTP error code.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2726 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2727 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2728 <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	2729 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2730 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2731 Error description.
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2732 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2733 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2734 <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	2735 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2736 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2737 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	2738 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2739 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2740 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2741 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2742 <literal>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	2743 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2744 <tag-desc>
2046 a810103f8a75 Changed summary and description style to flow scalar in yaml. Yaroslav Zhuravlev <yar@nginx.com> parents: 2034 diff changeset	2745 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	2746 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2747 <tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2748 <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	2749 </tag-name>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2750 <tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2751 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	2752 </tag-desc>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2753 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2754 </listitem>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2755 </list>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2756 </para>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2757 </section>
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2758
7e7edf832099 Added the generated ngx_http_api_module and separate target for it. Vladimir Homutov <vl@nginx.com> parents: diff changeset	2759 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_api_module.xml @ 2046:a810103f8a75