comparison 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
comparison
equal deleted inserted replaced
2045:ae16f480c867 2046:a810103f8a75
168 <tag-desc> 168 <tag-desc>
169 <para>Supported methods:</para> 169 <para>Supported methods:</para>
170 <list type="bullet" compact="yes"> 170 <list type="bullet" compact="yes">
171 <listitem id="getAPIEndpoints"> 171 <listitem id="getAPIEndpoints">
172 <literal>GET</literal> - Return list of root endpoints 172 <literal>GET</literal> - Return list of root endpoints
173
174 <para>Returns a list of root endpoints.</para> 173 <para>Returns a list of root endpoints.</para>
175 <para> 174 <para>
176 Possible responses: 175 Possible responses:
177 </para> 176 </para>
178 <list type="bullet"> 177 <list type="bullet">
187 <tag-desc> 186 <tag-desc>
188 <para>Supported methods:</para> 187 <para>Supported methods:</para>
189 <list type="bullet" compact="yes"> 188 <list type="bullet" compact="yes">
190 <listitem id="getNginx"> 189 <listitem id="getNginx">
191 <literal>GET</literal> - Return status of nginx running instance 190 <literal>GET</literal> - Return status of nginx running instance
192 191 <para>Returns nginx version, build name, address, number of configuration reloads, IDs of master and worker processes.</para>
193 <para>Returns nginx version, build name, address,
194 number of configuration reloads, IDs of master and worker processes.</para>
195 <para> 192 <para>
196 Request parameters: 193 Request parameters:
197 <list type="tag"> 194 <list type="tag">
198 <tag-name><literal>fields</literal> 195 <tag-name><literal>fields</literal>
199 (<literal>string</literal>, optional)</tag-name> 196 (<literal>string</literal>, optional)</tag-name>
216 <tag-desc> 213 <tag-desc>
217 <para>Supported methods:</para> 214 <para>Supported methods:</para>
218 <list type="bullet" compact="yes"> 215 <list type="bullet" compact="yes">
219 <listitem id="getProcesses"> 216 <listitem id="getProcesses">
220 <literal>GET</literal> - Return nginx processes status 217 <literal>GET</literal> - Return nginx processes status
221 218 <para>Returns the number of abnormally terminated and respawned child processes.</para>
222 <para>Returns the number of abnormally terminated
223 and respawned child processes.</para>
224 <para> 219 <para>
225 Possible responses: 220 Possible responses:
226 </para> 221 </para>
227 <list type="bullet"> 222 <list type="bullet">
228 <listitem>200 - Success, returns <link id="def_nginx_processes">Processes</link></listitem> 223 <listitem>200 - Success, returns <link id="def_nginx_processes">Processes</link></listitem>
229 </list> 224 </list>
230 </listitem> 225 </listitem>
231 <listitem id="deleteProcesses"> 226 <listitem id="deleteProcesses">
232 <literal>DELETE</literal> - Reset nginx processes statistics 227 <literal>DELETE</literal> - Reset nginx processes statistics
233 228 <para>Resets counters of abnormally terminated and respawned child processes.</para>
234 <para>Resets counters of abnormally terminated and respawned
235 child processes.</para>
236 <para> 229 <para>
237 Possible responses: 230 Possible responses:
238 </para> 231 </para>
239 <list type="bullet"> 232 <list type="bullet">
240 <listitem>204 - Success</listitem> 233 <listitem>204 - Success</listitem>
248 <tag-desc> 241 <tag-desc>
249 <para>Supported methods:</para> 242 <para>Supported methods:</para>
250 <list type="bullet" compact="yes"> 243 <list type="bullet" compact="yes">
251 <listitem id="getConnections"> 244 <listitem id="getConnections">
252 <literal>GET</literal> - Return client connections statistics 245 <literal>GET</literal> - Return client connections statistics
253
254 <para>Returns statistics of client connections.</para> 246 <para>Returns statistics of client connections.</para>
255 <para> 247 <para>
256 Request parameters: 248 Request parameters:
257 <list type="tag"> 249 <list type="tag">
258 <tag-name><literal>fields</literal> 250 <tag-name><literal>fields</literal>
268 <listitem>200 - Success, returns <link id="def_nginx_connections">Connections</link></listitem> 260 <listitem>200 - Success, returns <link id="def_nginx_connections">Connections</link></listitem>
269 </list> 261 </list>
270 </listitem> 262 </listitem>
271 <listitem id="deleteConnections"> 263 <listitem id="deleteConnections">
272 <literal>DELETE</literal> - Reset client connections statistics 264 <literal>DELETE</literal> - Reset client connections statistics
273 265 <para>Resets statistics of accepted and dropped client connections.</para>
274 <para>Resets statistics of accepted and dropped
275 client connections.</para>
276 <para> 266 <para>
277 Possible responses: 267 Possible responses:
278 </para> 268 </para>
279 <list type="bullet"> 269 <list type="bullet">
280 <listitem>204 - Success</listitem> 270 <listitem>204 - Success</listitem>
288 <tag-desc> 278 <tag-desc>
289 <para>Supported methods:</para> 279 <para>Supported methods:</para>
290 <list type="bullet" compact="yes"> 280 <list type="bullet" compact="yes">
291 <listitem id="getSsl"> 281 <listitem id="getSsl">
292 <literal>GET</literal> - Return SSL statistics 282 <literal>GET</literal> - Return SSL statistics
293
294 <para>Returns SSL statistics.</para> 283 <para>Returns SSL statistics.</para>
295 <para> 284 <para>
296 Request parameters: 285 Request parameters:
297 <list type="tag"> 286 <list type="tag">
298 <tag-name><literal>fields</literal> 287 <tag-name><literal>fields</literal>
308 <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem> 297 <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem>
309 </list> 298 </list>
310 </listitem> 299 </listitem>
311 <listitem id="deleteSslStat"> 300 <listitem id="deleteSslStat">
312 <literal>DELETE</literal> - Reset SSL statistics 301 <literal>DELETE</literal> - Reset SSL statistics
313
314 <para>Resets counters of SSL handshakes and session reuses.</para> 302 <para>Resets counters of SSL handshakes and session reuses.</para>
315 <para> 303 <para>
316 Possible responses: 304 Possible responses:
317 </para> 305 </para>
318 <list type="bullet"> 306 <list type="bullet">
327 <tag-desc> 315 <tag-desc>
328 <para>Supported methods:</para> 316 <para>Supported methods:</para>
329 <list type="bullet" compact="yes"> 317 <list type="bullet" compact="yes">
330 <listitem id="getSlabs"> 318 <listitem id="getSlabs">
331 <literal>GET</literal> - Return status of all slabs 319 <literal>GET</literal> - Return status of all slabs
332 320 <para>Returns status of slabs for each shared memory zone with slab allocator.</para>
333 <para>Returns status of slabs
334 for each shared memory zone with slab allocator.</para>
335 <para> 321 <para>
336 Request parameters: 322 Request parameters:
337 <list type="tag"> 323 <list type="tag">
338 <tag-name><literal>fields</literal> 324 <tag-name><literal>fields</literal>
339 (<literal>string</literal>, optional)</tag-name> 325 (<literal>string</literal>, optional)</tag-name>
340 <tag-desc> 326 <tag-desc>
341 Limits which fields of slab zones will be output. 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>
342 If the “<literal>fields</literal>” value is empty,
343 then only zone names are output.</tag-desc>
344 </list> 328 </list>
345 </para> 329 </para>
346 <para> 330 <para>
347 Possible responses: 331 Possible responses:
348 </para> 332 </para>
365 </list> 349 </list>
366 <para>Supported methods:</para> 350 <para>Supported methods:</para>
367 <list type="bullet" compact="yes"> 351 <list type="bullet" compact="yes">
368 <listitem id="getSlabZone"> 352 <listitem id="getSlabZone">
369 <literal>GET</literal> - Return status of a slab 353 <literal>GET</literal> - Return status of a slab
370 354 <para>Returns status of slabs for a particular shared memory zone with slab allocator.</para>
371 <para>Returns status of slabs for a particular shared memory zone
372 with slab allocator.</para>
373 <para> 355 <para>
374 Request parameters: 356 Request parameters:
375 <list type="tag"> 357 <list type="tag">
376 <tag-name><literal>fields</literal> 358 <tag-name><literal>fields</literal>
377 (<literal>string</literal>, optional)</tag-name> 359 (<literal>string</literal>, optional)</tag-name>
387 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 369 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
388 </list> 370 </list>
389 </listitem> 371 </listitem>
390 <listitem id="deleteSlabZoneStats"> 372 <listitem id="deleteSlabZoneStats">
391 <literal>DELETE</literal> - Reset slab statistics 373 <literal>DELETE</literal> - Reset slab statistics
392 374 <para>Resets the “<literal>reqs</literal>” and “<literal>fails</literal>” metrics for each memory slot.</para>
393 <para>Resets the “<literal>reqs</literal>” and “<literal>fails</literal>”
394 metrics for each memory slot.</para>
395 <para> 375 <para>
396 Possible responses: 376 Possible responses:
397 </para> 377 </para>
398 <list type="bullet"> 378 <list type="bullet">
399 <listitem>204 - Success</listitem> 379 <listitem>204 - Success</listitem>
408 <tag-desc> 388 <tag-desc>
409 <para>Supported methods:</para> 389 <para>Supported methods:</para>
410 <list type="bullet" compact="yes"> 390 <list type="bullet" compact="yes">
411 <listitem id="getHttp"> 391 <listitem id="getHttp">
412 <literal>GET</literal> - Return list of HTTP-related endpoints 392 <literal>GET</literal> - Return list of HTTP-related endpoints
413
414 <para>Returns a list of first level HTTP endpoints.</para> 393 <para>Returns a list of first level HTTP endpoints.</para>
415 <para> 394 <para>
416 Possible responses: 395 Possible responses:
417 </para> 396 </para>
418 <list type="bullet"> 397 <list type="bullet">
427 <tag-desc> 406 <tag-desc>
428 <para>Supported methods:</para> 407 <para>Supported methods:</para>
429 <list type="bullet" compact="yes"> 408 <list type="bullet" compact="yes">
430 <listitem id="getHttpRequests"> 409 <listitem id="getHttpRequests">
431 <literal>GET</literal> - Return HTTP requests statistics 410 <literal>GET</literal> - Return HTTP requests statistics
432
433 <para>Returns status of client HTTP requests.</para> 411 <para>Returns status of client HTTP requests.</para>
434 <para> 412 <para>
435 Request parameters: 413 Request parameters:
436 <list type="tag"> 414 <list type="tag">
437 <tag-name><literal>fields</literal> 415 <tag-name><literal>fields</literal>
438 (<literal>string</literal>, optional)</tag-name> 416 (<literal>string</literal>, optional)</tag-name>
439 <tag-desc> 417 <tag-desc>
440 Limits which fields of client HTTP requests statistics 418 Limits which fields of client HTTP requests statistics will be output.</tag-desc>
441 will be output.</tag-desc>
442 </list> 419 </list>
443 </para> 420 </para>
444 <para> 421 <para>
445 Possible responses: 422 Possible responses:
446 </para> 423 </para>
448 <listitem>200 - Success, returns <link id="def_nginx_http_requests">HTTP Requests</link></listitem> 425 <listitem>200 - Success, returns <link id="def_nginx_http_requests">HTTP Requests</link></listitem>
449 </list> 426 </list>
450 </listitem> 427 </listitem>
451 <listitem id="deleteHttpRequests"> 428 <listitem id="deleteHttpRequests">
452 <literal>DELETE</literal> - Reset HTTP requests statistics 429 <literal>DELETE</literal> - Reset HTTP requests statistics
453
454 <para>Resets the number of total client HTTP requests.</para> 430 <para>Resets the number of total client HTTP requests.</para>
455 <para> 431 <para>
456 Possible responses: 432 Possible responses:
457 </para> 433 </para>
458 <list type="bullet"> 434 <list type="bullet">
467 <tag-desc> 443 <tag-desc>
468 <para>Supported methods:</para> 444 <para>Supported methods:</para>
469 <list type="bullet" compact="yes"> 445 <list type="bullet" compact="yes">
470 <listitem id="getHttpServerZones"> 446 <listitem id="getHttpServerZones">
471 <literal>GET</literal> - Return status of all HTTP server zones 447 <literal>GET</literal> - Return status of all HTTP server zones
472 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>
473 <para>Returns status information for each HTTP
474 <link url="https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone">server zone</link>.</para>
475 <para> 449 <para>
476 Request parameters: 450 Request parameters:
477 <list type="tag"> 451 <list type="tag">
478 <tag-name><literal>fields</literal> 452 <tag-name><literal>fields</literal>
479 (<literal>string</literal>, optional)</tag-name> 453 (<literal>string</literal>, optional)</tag-name>
480 <tag-desc> 454 <tag-desc>
481 Limits which fields of server zones will be output. 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>
482 If the “<literal>fields</literal>” value is empty,
483 then only server zone names are output.</tag-desc>
484 </list> 456 </list>
485 </para> 457 </para>
486 <para> 458 <para>
487 Possible responses: 459 Possible responses:
488 </para> 460 </para>
505 </list> 477 </list>
506 <para>Supported methods:</para> 478 <para>Supported methods:</para>
507 <list type="bullet" compact="yes"> 479 <list type="bullet" compact="yes">
508 <listitem id="getHttpServerZone"> 480 <listitem id="getHttpServerZone">
509 <literal>GET</literal> - Return status of an HTTP server zone 481 <literal>GET</literal> - Return status of an HTTP server zone
510
511 <para>Returns status of a particular HTTP server zone.</para> 482 <para>Returns status of a particular HTTP server zone.</para>
512 <para> 483 <para>
513 Request parameters: 484 Request parameters:
514 <list type="tag"> 485 <list type="tag">
515 <tag-name><literal>fields</literal> 486 <tag-name><literal>fields</literal>
526 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 497 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
527 </list> 498 </list>
528 </listitem> 499 </listitem>
529 <listitem id="deleteHttpServerZoneStat"> 500 <listitem id="deleteHttpServerZoneStat">
530 <literal>DELETE</literal> - Reset statistics for an HTTP server zone 501 <literal>DELETE</literal> - Reset statistics for an HTTP server zone
531 502 <para>Resets statistics of accepted and discarded requests, responses, received and sent bytes in a particular HTTP server zone.</para>
532 <para>Resets statistics of accepted and discarded requests, responses,
533 received and sent bytes in a particular HTTP server zone.</para>
534 <para> 503 <para>
535 Possible responses: 504 Possible responses:
536 </para> 505 </para>
537 <list type="bullet"> 506 <list type="bullet">
538 <listitem>204 - Success</listitem> 507 <listitem>204 - Success</listitem>
547 <tag-desc> 516 <tag-desc>
548 <para>Supported methods:</para> 517 <para>Supported methods:</para>
549 <list type="bullet" compact="yes"> 518 <list type="bullet" compact="yes">
550 <listitem id="getHttpCaches"> 519 <listitem id="getHttpCaches">
551 <literal>GET</literal> - Return status of all caches 520 <literal>GET</literal> - Return status of all caches
552 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>
553 <para>Returns status of each cache configured by
554 <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path">proxy_cache_path</link>
555 and other “<literal>*_cache_path</literal>” directives.</para>
556 <para> 522 <para>
557 Request parameters: 523 Request parameters:
558 <list type="tag"> 524 <list type="tag">
559 <tag-name><literal>fields</literal> 525 <tag-name><literal>fields</literal>
560 (<literal>string</literal>, optional)</tag-name> 526 (<literal>string</literal>, optional)</tag-name>
561 <tag-desc> 527 <tag-desc>
562 Limits which fields of cache zones will be output. 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>
563 If the “<literal>fields</literal>” value is empty,
564 then only names of cache zones are output.</tag-desc>
565 </list> 529 </list>
566 </para> 530 </para>
567 <para> 531 <para>
568 Possible responses: 532 Possible responses:
569 </para> 533 </para>
586 </list> 550 </list>
587 <para>Supported methods:</para> 551 <para>Supported methods:</para>
588 <list type="bullet" compact="yes"> 552 <list type="bullet" compact="yes">
589 <listitem id="getHttpCacheZone"> 553 <listitem id="getHttpCacheZone">
590 <literal>GET</literal> - Return status of a cache 554 <literal>GET</literal> - Return status of a cache
591
592 <para>Returns status of a particular cache.</para> 555 <para>Returns status of a particular cache.</para>
593 <para> 556 <para>
594 Request parameters: 557 Request parameters:
595 <list type="tag"> 558 <list type="tag">
596 <tag-name><literal>fields</literal> 559 <tag-name><literal>fields</literal>
607 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 570 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
608 </list> 571 </list>
609 </listitem> 572 </listitem>
610 <listitem id="deleteHttpCacheZoneStat"> 573 <listitem id="deleteHttpCacheZoneStat">
611 <literal>DELETE</literal> - Reset cache statistics 574 <literal>DELETE</literal> - Reset cache statistics
612
613 <para>Resets statistics of cache hits/misses in a particular cache zone.</para> 575 <para>Resets statistics of cache hits/misses in a particular cache zone.</para>
614 <para> 576 <para>
615 Possible responses: 577 Possible responses:
616 </para> 578 </para>
617 <list type="bullet"> 579 <list type="bullet">
627 <tag-desc> 589 <tag-desc>
628 <para>Supported methods:</para> 590 <para>Supported methods:</para>
629 <list type="bullet" compact="yes"> 591 <list type="bullet" compact="yes">
630 <listitem id="getHttpUpstreams"> 592 <listitem id="getHttpUpstreams">
631 <literal>GET</literal> - Return status of all HTTP upstream server groups 593 <literal>GET</literal> - Return status of all HTTP upstream server groups
632 594 <para>Returns status of each HTTP upstream server group and its servers.</para>
633 <para>Returns status of each HTTP upstream server group
634 and its servers.</para>
635 <para> 595 <para>
636 Request parameters: 596 Request parameters:
637 <list type="tag"> 597 <list type="tag">
638 <tag-name><literal>fields</literal> 598 <tag-name><literal>fields</literal>
639 (<literal>string</literal>, optional)</tag-name> 599 (<literal>string</literal>, optional)</tag-name>
640 <tag-desc> 600 <tag-desc>
641 Limits which fields of upstream server groups will be output. 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>
642 If the “<literal>fields</literal>” value is empty,
643 only names of upstreams are output.</tag-desc>
644 </list> 602 </list>
645 </para> 603 </para>
646 <para> 604 <para>
647 Possible responses: 605 Possible responses:
648 </para> 606 </para>
665 </list> 623 </list>
666 <para>Supported methods:</para> 624 <para>Supported methods:</para>
667 <list type="bullet" compact="yes"> 625 <list type="bullet" compact="yes">
668 <listitem id="getHttpUpstreamName"> 626 <listitem id="getHttpUpstreamName">
669 <literal>GET</literal> - Return status of an HTTP upstream server group 627 <literal>GET</literal> - Return status of an HTTP upstream server group
670 628 <para>Returns status of a particular HTTP upstream server group and its servers.</para>
671 <para>Returns status of a particular HTTP upstream server group
672 and its servers.</para>
673 <para> 629 <para>
674 Request parameters: 630 Request parameters:
675 <list type="tag"> 631 <list type="tag">
676 <tag-name><literal>fields</literal> 632 <tag-name><literal>fields</literal>
677 (<literal>string</literal>, optional)</tag-name> 633 (<literal>string</literal>, optional)</tag-name>
688 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 644 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
689 </list> 645 </list>
690 </listitem> 646 </listitem>
691 <listitem id="deleteHttpUpstreamStat"> 647 <listitem id="deleteHttpUpstreamStat">
692 <literal>DELETE</literal> - Reset statistics of an HTTP upstream server group 648 <literal>DELETE</literal> - Reset statistics of an HTTP upstream server group
693 649 <para>Resets the statistics for each upstream server in an upstream server group and queue statistics.</para>
694 <para>Resets the statistics for each upstream server
695 in an upstream server group and queue statistics.</para>
696 <para> 650 <para>
697 Possible responses: 651 Possible responses:
698 </para> 652 </para>
699 <list type="bullet"> 653 <list type="bullet">
700 <listitem>204 - Success</listitem> 654 <listitem>204 - Success</listitem>
717 </list> 671 </list>
718 <para>Supported methods:</para> 672 <para>Supported methods:</para>
719 <list type="bullet" compact="yes"> 673 <list type="bullet" compact="yes">
720 <listitem id="getHttpUpstreamServers"> 674 <listitem id="getHttpUpstreamServers">
721 <literal>GET</literal> - Return configuration of all servers in an HTTP upstream server group 675 <literal>GET</literal> - Return configuration of all servers in an HTTP upstream server group
722 676 <para>Returns configuration of each server in a particular HTTP upstream server group.</para>
723 <para>Returns configuration of each server
724 in a particular HTTP upstream server group.</para>
725 <para> 677 <para>
726 Possible responses: 678 Possible responses:
727 </para> 679 </para>
728 <list type="bullet"> 680 <list type="bullet">
729 <listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem> 681 <listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem>
731 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 683 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
732 </list> 684 </list>
733 </listitem> 685 </listitem>
734 <listitem id="postHttpUpstreamServer"> 686 <listitem id="postHttpUpstreamServer">
735 <literal>POST</literal> - Add a server to an HTTP upstream server group 687 <literal>POST</literal> - Add a server to an HTTP upstream server group
736 688 <para>Adds a new server to an HTTP upstream server group. Server parameters are specified in the JSON format.</para>
737 <para>Adds a new server to an HTTP upstream server group.
738 Server parameters are specified in the JSON format.</para>
739 <para> 689 <para>
740 Request parameters: 690 Request parameters:
741 <list type="tag"> 691 <list type="tag">
742 <tag-name><literal>postHttpUpstreamServer</literal> 692 <tag-name><literal>postHttpUpstreamServer</literal>
743 (<link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link>, required)</tag-name> 693 (<link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link>, required)</tag-name>
744 <tag-desc> 694 <tag-desc>
745 Address of a new server and other optional parameters 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>
746 in the JSON format.
747 The “<literal>ID</literal>”, “<literal>backup</literal>”, and “<literal>service</literal>” parameters
748 cannot be changed.</tag-desc>
749 </list> 696 </list>
750 </para> 697 </para>
751 <para> 698 <para>
752 Possible responses: 699 Possible responses:
753 </para> 700 </para>
794 </list> 741 </list>
795 <para>Supported methods:</para> 742 <para>Supported methods:</para>
796 <list type="bullet" compact="yes"> 743 <list type="bullet" compact="yes">
797 <listitem id="getHttpUpstreamPeer"> 744 <listitem id="getHttpUpstreamPeer">
798 <literal>GET</literal> - Return configuration of a server in an HTTP upstream server group 745 <literal>GET</literal> - Return configuration of a server in an HTTP upstream server group
799 746 <para>Returns configuration of a particular server in the HTTP upstream server group.</para>
800 <para>Returns configuration of a particular server
801 in the HTTP upstream server group.</para>
802 <para> 747 <para>
803 Possible responses: 748 Possible responses:
804 </para> 749 </para>
805 <list type="bullet"> 750 <list type="bullet">
806 <listitem>200 - Success, returns <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link></listitem> 751 <listitem>200 - Success, returns <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link></listitem>
810 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 755 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
811 </list> 756 </list>
812 </listitem> 757 </listitem>
813 <listitem id="patchHttpUpstreamPeer"> 758 <listitem id="patchHttpUpstreamPeer">
814 <literal>PATCH</literal> - Modify a server in an HTTP upstream server group 759 <literal>PATCH</literal> - Modify a server in an HTTP upstream server group
815 760 <para>Modifies settings of a particular server in an HTTP upstream server group. Server parameters are specified in the JSON format.</para>
816 <para>Modifies settings of a particular server
817 in an HTTP upstream server group.
818 Server parameters are specified in the JSON format.</para>
819 <para> 761 <para>
820 Request parameters: 762 Request parameters:
821 <list type="tag"> 763 <list type="tag">
822 <tag-name><literal>patchHttpUpstreamServer</literal> 764 <tag-name><literal>patchHttpUpstreamServer</literal>
823 (<link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link>, required)</tag-name> 765 (<link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link>, required)</tag-name>
824 <tag-desc> 766 <tag-desc>
825 Server parameters, specified in the JSON format. 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>
826 The “<literal>ID</literal>”, “<literal>backup</literal>”, and “<literal>service</literal>” parameters
827 cannot be changed.</tag-desc>
828 </list> 768 </list>
829 </para> 769 </para>
830 <para> 770 <para>
831 Possible responses: 771 Possible responses:
832 </para> 772 </para>
854 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 794 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
855 </list> 795 </list>
856 </listitem> 796 </listitem>
857 <listitem id="deleteHttpUpstreamServer"> 797 <listitem id="deleteHttpUpstreamServer">
858 <literal>DELETE</literal> - Remove a server from an HTTP upstream server group 798 <literal>DELETE</literal> - Remove a server from an HTTP upstream server group
859
860 <para>Removes a server from an HTTP upstream server group.</para> 799 <para>Removes a server from an HTTP upstream server group.</para>
861 <para> 800 <para>
862 Possible responses: 801 Possible responses:
863 </para> 802 </para>
864 <list type="bullet"> 803 <list type="bullet">
878 <tag-desc> 817 <tag-desc>
879 <para>Supported methods:</para> 818 <para>Supported methods:</para>
880 <list type="bullet" compact="yes"> 819 <list type="bullet" compact="yes">
881 <listitem id="getHttpKeyvalZones"> 820 <listitem id="getHttpKeyvalZones">
882 <literal>GET</literal> - Return key-value pairs from all keyval zones 821 <literal>GET</literal> - Return key-value pairs from all keyval zones
883 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>
884 <para>Returns key-value pairs for each keyval shared memory
885 <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>.</para>
886 <para> 823 <para>
887 Request parameters: 824 Request parameters:
888 <list type="tag"> 825 <list type="tag">
889 <tag-name><literal>fields</literal> 826 <tag-name><literal>fields</literal>
890 (<literal>string</literal>, optional)</tag-name> 827 (<literal>string</literal>, optional)</tag-name>
891 <tag-desc> 828 <tag-desc>
892 If the “<literal>fields</literal>” value is empty, 829 If the “<literal>fields</literal>” value is empty, then only keyval zone names are output.</tag-desc>
893 then only keyval zone names are output.</tag-desc>
894 </list> 830 </list>
895 </para> 831 </para>
896 <para> 832 <para>
897 Possible responses: 833 Possible responses:
898 </para> 834 </para>
915 </list> 851 </list>
916 <para>Supported methods:</para> 852 <para>Supported methods:</para>
917 <list type="bullet" compact="yes"> 853 <list type="bullet" compact="yes">
918 <listitem id="getHttpKeyvalZoneKeysValues"> 854 <listitem id="getHttpKeyvalZoneKeysValues">
919 <literal>GET</literal> - Return key-value pairs from a keyval zone 855 <literal>GET</literal> - Return key-value pairs from a keyval zone
920 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>
921 <para>Returns key-value pairs stored in a particular keyval shared memory
922 <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>.</para>
923 <para> 857 <para>
924 Request parameters: 858 Request parameters:
925 <list type="tag"> 859 <list type="tag">
926 <tag-name><literal>key</literal> 860 <tag-name><literal>key</literal>
927 (<literal>string</literal>, optional)</tag-name> 861 (<literal>string</literal>, optional)</tag-name>
938 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 872 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
939 </list> 873 </list>
940 </listitem> 874 </listitem>
941 <listitem id="postHttpKeyvalZoneData"> 875 <listitem id="postHttpKeyvalZoneData">
942 <literal>POST</literal> - Add a key-value pair to the keyval zone 876 <literal>POST</literal> - Add a key-value pair to the keyval zone
943 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>
944 <para>Adds a new key-value pair to the keyval shared memory
945 <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>.
946 Several key-value pairs can be entered
947 if the keyval shared memory zone is empty.</para>
948 <para> 878 <para>
949 Request parameters: 879 Request parameters:
950 <list type="tag"> 880 <list type="tag">
951 <tag-name><literal>Key-value</literal> 881 <tag-name><literal>Key-value</literal>
952 (<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</link>, required)</tag-name> 882 (<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</link>, required)</tag-name>
953 <tag-desc> 883 <tag-desc>
954 A key-value pair is specified in the JSON format. 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>
955 Several key-value pairs can be entered
956 if the keyval shared memory zone is empty.</tag-desc>
957 </list> 885 </list>
958 </para> 886 </para>
959 <para> 887 <para>
960 Possible responses: 888 Possible responses:
961 </para> 889 </para>
969 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 897 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
970 </list> 898 </list>
971 </listitem> 899 </listitem>
972 <listitem id="patchHttpKeyvalZoneKeyValue"> 900 <listitem id="patchHttpKeyvalZoneKeyValue">
973 <literal>PATCH</literal> - Modify a key-value or delete a key 901 <literal>PATCH</literal> - Modify a key-value or delete a key
974 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>
975 <para>Changes the value of the selected key in the key-value pair
976 or deletes a key by setting the key value to <literal>null</literal>.</para>
977 <para> 903 <para>
978 Request parameters: 904 Request parameters:
979 <list type="tag"> 905 <list type="tag">
980 <tag-name><literal>httpKeyvalZoneKeyValue</literal> 906 <tag-name><literal>httpKeyvalZoneKeyValue</literal>
981 (<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</link>, required)</tag-name> 907 (<link id="def_nginx_http_keyval_zone">Keyval Shared Memory Zone</link>, required)</tag-name>
996 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 922 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
997 </list> 923 </list>
998 </listitem> 924 </listitem>
999 <listitem id="deleteHttpKeyvalZoneData"> 925 <listitem id="deleteHttpKeyvalZoneData">
1000 <literal>DELETE</literal> - Empty the keyval zone 926 <literal>DELETE</literal> - Empty the keyval zone
1001 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>
1002 <para>Deletes all key-value pairs from the keyval shared memory
1003 <link url="https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone">zone</link>.</para>
1004 <para> 928 <para>
1005 Possible responses: 929 Possible responses:
1006 </para> 930 </para>
1007 <list type="bullet"> 931 <list type="bullet">
1008 <listitem>204 - Success</listitem> 932 <listitem>204 - Success</listitem>
1017 <tag-desc> 941 <tag-desc>
1018 <para>Supported methods:</para> 942 <para>Supported methods:</para>
1019 <list type="bullet" compact="yes"> 943 <list type="bullet" compact="yes">
1020 <listitem id="getStream"> 944 <listitem id="getStream">
1021 <literal>GET</literal> - Return list of stream-related endpoints 945 <literal>GET</literal> - Return list of stream-related endpoints
1022
1023 <para>Returns a list of first level stream endpoints.</para> 946 <para>Returns a list of first level stream endpoints.</para>
1024 <para> 947 <para>
1025 Possible responses: 948 Possible responses:
1026 </para> 949 </para>
1027 <list type="bullet"> 950 <list type="bullet">
1036 <tag-desc> 959 <tag-desc>
1037 <para>Supported methods:</para> 960 <para>Supported methods:</para>
1038 <list type="bullet" compact="yes"> 961 <list type="bullet" compact="yes">
1039 <listitem id="getStreamServerZones"> 962 <listitem id="getStreamServerZones">
1040 <literal>GET</literal> - Return status of all stream server zones 963 <literal>GET</literal> - Return status of all stream server zones
1041 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>
1042 <para>Returns status information for each stream
1043 <link url="https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone">server zone</link>.</para>
1044 <para> 965 <para>
1045 Request parameters: 966 Request parameters:
1046 <list type="tag"> 967 <list type="tag">
1047 <tag-name><literal>fields</literal> 968 <tag-name><literal>fields</literal>
1048 (<literal>string</literal>, optional)</tag-name> 969 (<literal>string</literal>, optional)</tag-name>
1049 <tag-desc> 970 <tag-desc>
1050 Limits which fields of server zones will be output. 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>
1051 If the “<literal>fields</literal>” value is empty,
1052 then only server zone names are output.</tag-desc>
1053 </list> 972 </list>
1054 </para> 973 </para>
1055 <para> 974 <para>
1056 Possible responses: 975 Possible responses:
1057 </para> 976 </para>
1058 <list type="bullet"> 977 <list type="bullet">
1059 <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> 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>
1060 <listitem>404 - <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1061 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1062 </list> 980 </list>
1063 </listitem> 981 </listitem>
1064 </list> 982 </list>
1065 </tag-desc> 983 </tag-desc>
1066 <tag-name id="stream_server_zones_stream_server_zone_name" name="/stream/server_zones/{streamServerZoneName}"> 984 <tag-name id="stream_server_zones_stream_server_zone_name" name="/stream/server_zones/{streamServerZoneName}">
1076 </list> 994 </list>
1077 <para>Supported methods:</para> 995 <para>Supported methods:</para>
1078 <list type="bullet" compact="yes"> 996 <list type="bullet" compact="yes">
1079 <listitem id="getStreamServerZone"> 997 <listitem id="getStreamServerZone">
1080 <literal>GET</literal> - Return status of a stream server zone 998 <literal>GET</literal> - Return status of a stream server zone
1081
1082 <para>Returns status of a particular stream server zone.</para> 999 <para>Returns status of a particular stream server zone.</para>
1083 <para> 1000 <para>
1084 Request parameters: 1001 Request parameters:
1085 <list type="tag"> 1002 <list type="tag">
1086 <tag-name><literal>fields</literal> 1003 <tag-name><literal>fields</literal>
1093 Possible responses: 1010 Possible responses:
1094 </para> 1011 </para>
1095 <list type="bullet"> 1012 <list type="bullet">
1096 <listitem>200 - Success, returns <link id="def_nginx_stream_server_zone">Stream Server Zone</link></listitem> 1013 <listitem>200 - Success, returns <link id="def_nginx_stream_server_zone">Stream Server Zone</link></listitem>
1097 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), 1014 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
1098 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1099 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1100 </list> 1016 </list>
1101 </listitem> 1017 </listitem>
1102 <listitem id="deleteStreamServerZoneStat"> 1018 <listitem id="deleteStreamServerZoneStat">
1103 <literal>DELETE</literal> - Reset statistics for a stream server zone 1019 <literal>DELETE</literal> - Reset statistics for a stream server zone
1104 1020 <para>Resets statistics of accepted and discarded connections, sessions, received and sent bytes in a particular stream server zone.</para>
1105 <para>Resets statistics of accepted and discarded connections, sessions,
1106 received and sent bytes in a particular stream server zone.</para>
1107 <para> 1021 <para>
1108 Possible responses: 1022 Possible responses:
1109 </para> 1023 </para>
1110 <list type="bullet"> 1024 <list type="bullet">
1111 <listitem>204 - Success</listitem> 1025 <listitem>204 - Success</listitem>
1112 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), 1026 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
1113 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1114 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1115 </list> 1028 </list>
1116 </listitem> 1029 </listitem>
1117 </list> 1030 </list>
1118 </tag-desc> 1031 </tag-desc>
1119 <tag-name id="stream_upstreams_" name="/stream/upstreams/"> 1032 <tag-name id="stream_upstreams_" name="/stream/upstreams/">
1122 <tag-desc> 1035 <tag-desc>
1123 <para>Supported methods:</para> 1036 <para>Supported methods:</para>
1124 <list type="bullet" compact="yes"> 1037 <list type="bullet" compact="yes">
1125 <listitem id="getStreamUpstreams"> 1038 <listitem id="getStreamUpstreams">
1126 <literal>GET</literal> - Return status of all stream upstream server groups 1039 <literal>GET</literal> - Return status of all stream upstream server groups
1127 1040 <para>Returns status of each stream upstream server group and its servers.</para>
1128 <para>Returns status of each stream upstream server group
1129 and its servers.</para>
1130 <para> 1041 <para>
1131 Request parameters: 1042 Request parameters:
1132 <list type="tag"> 1043 <list type="tag">
1133 <tag-name><literal>fields</literal> 1044 <tag-name><literal>fields</literal>
1134 (<literal>string</literal>, optional)</tag-name> 1045 (<literal>string</literal>, optional)</tag-name>
1135 <tag-desc> 1046 <tag-desc>
1136 Limits which fields of upstream server groups will be output. 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>
1137 If the “<literal>fields</literal>” value is empty,
1138 only names of upstreams are output.</tag-desc>
1139 </list> 1048 </list>
1140 </para> 1049 </para>
1141 <para> 1050 <para>
1142 Possible responses: 1051 Possible responses:
1143 </para> 1052 </para>
1144 <list type="bullet"> 1053 <list type="bullet">
1145 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams </listitem> 1054 <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams </listitem>
1146 <listitem>404 - <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1147 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1148 </list> 1056 </list>
1149 </listitem> 1057 </listitem>
1150 </list> 1058 </list>
1151 </tag-desc> 1059 </tag-desc>
1152 <tag-name id="stream_upstreams_stream_upstream_name_" name="/stream/upstreams/{streamUpstreamName}/"> 1060 <tag-name id="stream_upstreams_stream_upstream_name_" name="/stream/upstreams/{streamUpstreamName}/">
1162 </list> 1070 </list>
1163 <para>Supported methods:</para> 1071 <para>Supported methods:</para>
1164 <list type="bullet" compact="yes"> 1072 <list type="bullet" compact="yes">
1165 <listitem id="getStreamUpstream"> 1073 <listitem id="getStreamUpstream">
1166 <literal>GET</literal> - Return status of a stream upstream server group 1074 <literal>GET</literal> - Return status of a stream upstream server group
1167 1075 <para>Returns status of a particular stream upstream server group and its servers.</para>
1168 <para>Returns status of a particular stream upstream server group
1169 and its servers.</para>
1170 <para> 1076 <para>
1171 Request parameters: 1077 Request parameters:
1172 <list type="tag"> 1078 <list type="tag">
1173 <tag-name><literal>fields</literal> 1079 <tag-name><literal>fields</literal>
1174 (<literal>string</literal>, optional)</tag-name> 1080 (<literal>string</literal>, optional)</tag-name>
1181 </para> 1087 </para>
1182 <list type="bullet"> 1088 <list type="bullet">
1183 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream">Stream Upstream</link></listitem> 1089 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream">Stream Upstream</link></listitem>
1184 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1090 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1185 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1091 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
1186 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1187 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1188 </list> 1093 </list>
1189 </listitem> 1094 </listitem>
1190 <listitem id="deleteStreamUpstreamStat"> 1095 <listitem id="deleteStreamUpstreamStat">
1191 <literal>DELETE</literal> - Reset statistics of a stream upstream server group 1096 <literal>DELETE</literal> - Reset statistics of a stream upstream server group
1192 1097 <para>Resets the statistics for each upstream server in an upstream server group.</para>
1193 <para>Resets the statistics for each upstream server
1194 in an upstream server group.</para>
1195 <para> 1098 <para>
1196 Possible responses: 1099 Possible responses:
1197 </para> 1100 </para>
1198 <list type="bullet"> 1101 <list type="bullet">
1199 <listitem>204 - Success</listitem> 1102 <listitem>204 - Success</listitem>
1200 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1103 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1201 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1104 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
1202 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1203 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1204 </list> 1106 </list>
1205 </listitem> 1107 </listitem>
1206 </list> 1108 </list>
1207 </tag-desc> 1109 </tag-desc>
1208 <tag-name id="stream_upstreams_stream_upstream_name_servers_" name="/stream/upstreams/{streamUpstreamName}/servers/"> 1110 <tag-name id="stream_upstreams_stream_upstream_name_servers_" name="/stream/upstreams/{streamUpstreamName}/servers/">
1218 </list> 1120 </list>
1219 <para>Supported methods:</para> 1121 <para>Supported methods:</para>
1220 <list type="bullet" compact="yes"> 1122 <list type="bullet" compact="yes">
1221 <listitem id="getStreamUpstreamServers"> 1123 <listitem id="getStreamUpstreamServers">
1222 <literal>GET</literal> - Return configuration of all servers in a stream upstream server group 1124 <literal>GET</literal> - Return configuration of all servers in a stream upstream server group
1223 1125 <para>Returns configuration of each server in a particular stream upstream server group.</para>
1224 <para>Returns configuration of each server
1225 in a particular stream upstream server group.</para>
1226 <para> 1126 <para>
1227 Possible responses: 1127 Possible responses:
1228 </para> 1128 </para>
1229 <list type="bullet"> 1129 <list type="bullet">
1230 <listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem> 1130 <listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem>
1231 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1131 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1232 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1132 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
1233 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1234 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1235 </list> 1134 </list>
1236 </listitem> 1135 </listitem>
1237 <listitem id="postStreamUpstreamServer"> 1136 <listitem id="postStreamUpstreamServer">
1238 <literal>POST</literal> - Add a server to a stream upstream server group 1137 <literal>POST</literal> - Add a server to a stream upstream server group
1239 1138 <para>Adds a new server to a stream upstream server group. Server parameters are specified in the JSON format.</para>
1240 <para>Adds a new server to a stream upstream server group.
1241 Server parameters are specified in the JSON format.</para>
1242 <para> 1139 <para>
1243 Request parameters: 1140 Request parameters:
1244 <list type="tag"> 1141 <list type="tag">
1245 <tag-name><literal>postStreamUpstreamServer</literal> 1142 <tag-name><literal>postStreamUpstreamServer</literal>
1246 (<link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link>, required)</tag-name> 1143 (<link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link>, required)</tag-name>
1247 <tag-desc> 1144 <tag-desc>
1248 Address of a new server and other optional parameters 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>
1249 in the JSON format.
1250 The “<literal>ID</literal>”, “<literal>backup</literal>”, and “<literal>service</literal>” parameters
1251 cannot be changed.</tag-desc>
1252 </list> 1146 </list>
1253 </para> 1147 </para>
1254 <para> 1148 <para>
1255 Possible responses: 1149 Possible responses:
1256 </para> 1150 </para>
1273 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), 1167 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>),
1274 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), 1168 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>),
1275 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), 1169 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>),
1276 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1170 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1277 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1171 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
1278 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1279 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1280 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1173 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1281 </list> 1174 </list>
1282 </listitem> 1175 </listitem>
1283 </list> 1176 </list>
1284 </tag-desc> 1177 </tag-desc>
1299 </list> 1192 </list>
1300 <para>Supported methods:</para> 1193 <para>Supported methods:</para>
1301 <list type="bullet" compact="yes"> 1194 <list type="bullet" compact="yes">
1302 <listitem id="getStreamUpstreamServer"> 1195 <listitem id="getStreamUpstreamServer">
1303 <literal>GET</literal> - Return configuration of a server in a stream upstream server group 1196 <literal>GET</literal> - Return configuration of a server in a stream upstream server group
1304 1197 <para>Returns configuration of a particular server in the stream upstream server group.</para>
1305 <para>Returns configuration of a particular server
1306 in the stream upstream server group.</para>
1307 <para> 1198 <para>
1308 Possible responses: 1199 Possible responses:
1309 </para> 1200 </para>
1310 <list type="bullet"> 1201 <list type="bullet">
1311 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link></listitem> 1202 <listitem>200 - Success, returns <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link></listitem>
1312 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), 1203 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>),
1313 invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1204 invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1314 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1205 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
1315 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), 1206 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
1316 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1317 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1318 </list> 1208 </list>
1319 </listitem> 1209 </listitem>
1320 <listitem id="patchStreamUpstreamServer"> 1210 <listitem id="patchStreamUpstreamServer">
1321 <literal>PATCH</literal> - Modify a server in a stream upstream server group 1211 <literal>PATCH</literal> - Modify a server in a stream upstream server group
1322 1212 <para>Modifies settings of a particular server in a stream upstream server group. Server parameters are specified in the JSON format.</para>
1323 <para>Modifies settings of a particular server
1324 in a stream upstream server group.
1325 Server parameters are specified in the JSON format.</para>
1326 <para> 1213 <para>
1327 Request parameters: 1214 Request parameters:
1328 <list type="tag"> 1215 <list type="tag">
1329 <tag-name><literal>patchStreamUpstreamServer</literal> 1216 <tag-name><literal>patchStreamUpstreamServer</literal>
1330 (<link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link>, required)</tag-name> 1217 (<link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link>, required)</tag-name>
1331 <tag-desc> 1218 <tag-desc>
1332 Server parameters, specified in the JSON format. 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>
1333 The “<literal>ID</literal>”, “<literal>backup</literal>”, and “<literal>service</literal>” parameters
1334 cannot be changed.</tag-desc>
1335 </list> 1220 </list>
1336 </para> 1221 </para>
1337 <para> 1222 <para>
1338 Possible responses: 1223 Possible responses:
1339 </para> 1224 </para>
1356 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), 1241 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>),
1357 server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), 1242 server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>),
1358 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1243 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1359 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1244 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
1360 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), 1245 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
1361 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1362 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1363 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1247 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1364 </list> 1248 </list>
1365 </listitem> 1249 </listitem>
1366 <listitem id="deleteStreamUpstreamServer"> 1250 <listitem id="deleteStreamUpstreamServer">
1367 <literal>DELETE</literal> - Remove a server from a stream upstream server group 1251 <literal>DELETE</literal> - Remove a server from a stream upstream server group
1368
1369 <para>Removes a server from a stream server group.</para> 1252 <para>Removes a server from a stream server group.</para>
1370 <para> 1253 <para>
1371 Possible responses: 1254 Possible responses:
1372 </para> 1255 </para>
1373 <list type="bullet"> 1256 <list type="bullet">
1375 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), 1258 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>),
1376 invalid server ID (<literal>UpstreamBadServerId</literal>), 1259 invalid server ID (<literal>UpstreamBadServerId</literal>),
1377 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1260 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1378 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1261 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
1379 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), 1262 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
1380 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> 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>
1381 not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1382 </list> 1264 </list>
1383 </listitem> 1265 </listitem>
1384 </list> 1266 </list>
1385 </tag-desc> 1267 </tag-desc>
1386 </list> 1268 </list>
1412 </tag-desc> 1294 </tag-desc>
1413 <tag-name> 1295 <tag-name>
1414 <literal>generation</literal> (<literal>integer</literal>) 1296 <literal>generation</literal> (<literal>integer</literal>)
1415 </tag-name> 1297 </tag-name>
1416 <tag-desc> 1298 <tag-desc>
1417 The total number of configuration 1299 The total number of configuration <link url="https://nginx.org/en/docs/control.html#reconfiguration">reloads</link>.
1418 <link url="https://nginx.org/en/docs/control.html#reconfiguration">reloads</link>.
1419 </tag-desc> 1300 </tag-desc>
1420 <tag-name> 1301 <tag-name>
1421 <literal>load_timestamp</literal> (<literal>string</literal>) 1302 <literal>load_timestamp</literal> (<literal>string</literal>)
1422 </tag-name> 1303 </tag-name>
1423 <tag-desc> 1304 <tag-desc>
1424 Time of the last reload of configuration, 1305 Time of the last reload of configuration, in milliseconds since Epoch.
1425 in milliseconds since Epoch.
1426 </tag-desc> 1306 </tag-desc>
1427 <tag-name> 1307 <tag-name>
1428 <literal>timestamp</literal> (<literal>string</literal>) 1308 <literal>timestamp</literal> (<literal>string</literal>)
1429 </tag-name> 1309 </tag-name>
1430 <tag-desc> 1310 <tag-desc>
1438 </tag-desc> 1318 </tag-desc>
1439 <tag-name> 1319 <tag-name>
1440 <literal>ppid</literal> (<literal>integer</literal>) 1320 <literal>ppid</literal> (<literal>integer</literal>)
1441 </tag-name> 1321 </tag-name>
1442 <tag-desc> 1322 <tag-desc>
1443 The ID of the master process that started the 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>.
1444 <link url="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</link>.
1445 </tag-desc> 1324 </tag-desc>
1446 </list> 1325 </list>
1447 <para>Example:</para> 1326 <para>Example:</para>
1448 <example> 1327 <example>
1449 { 1328 {
1464 <list type="tag"> 1343 <list type="tag">
1465 <tag-name> 1344 <tag-name>
1466 <literal>respawned</literal> (<literal>integer</literal>) 1345 <literal>respawned</literal> (<literal>integer</literal>)
1467 </tag-name> 1346 </tag-name>
1468 <tag-desc> 1347 <tag-desc>
1469 The total number of abnormally terminated 1348 The total number of abnormally terminated and respawned child processes.
1470 and respawned child processes.
1471 </tag-desc> 1349 </tag-desc>
1472 </list> 1350 </list>
1473 <para>Example:</para> 1351 <para>Example:</para>
1474 <example> 1352 <example>
1475 { 1353 {
1634 </tag-desc> 1512 </tag-desc>
1635 <tag-name> 1513 <tag-name>
1636 <literal>reqs</literal> (<literal>integer</literal>) 1514 <literal>reqs</literal> (<literal>integer</literal>)
1637 </tag-name> 1515 </tag-name>
1638 <tag-desc> 1516 <tag-desc>
1639 The total number of attempts 1517 The total number of attempts to allocate memory of specified size.
1640 to allocate memory of specified size.
1641 </tag-desc> 1518 </tag-desc>
1642 <tag-name> 1519 <tag-name>
1643 <literal>fails</literal> (<literal>integer</literal>) 1520 <literal>fails</literal> (<literal>integer</literal>)
1644 </tag-name> 1521 </tag-name>
1645 <tag-desc> 1522 <tag-desc>
1646 The number of unsuccessful attempts 1523 The number of unsuccessful attempts to allocate memory of specified size.
1647 to allocate memory of specified size.
1648 </tag-desc> 1524 </tag-desc>
1649 </list> 1525 </list>
1650 </listitem> 1526 </listitem>
1651 <listitem id="def_nginx_http_requests"> 1527 <listitem id="def_nginx_http_requests">
1652 <para>HTTP Requests:</para> 1528 <para>HTTP Requests:</para>
1676 <list type="tag"> 1552 <list type="tag">
1677 <tag-name> 1553 <tag-name>
1678 <literal>processing</literal> (<literal>integer</literal>) 1554 <literal>processing</literal> (<literal>integer</literal>)
1679 </tag-name> 1555 </tag-name>
1680 <tag-desc> 1556 <tag-desc>
1681 The number of client requests 1557 The number of client requests that are currently being processed.
1682 that are currently being processed.
1683 </tag-desc> 1558 </tag-desc>
1684 <tag-name> 1559 <tag-name>
1685 <literal>requests</literal> (<literal>integer</literal>) 1560 <literal>requests</literal> (<literal>integer</literal>)
1686 </tag-name> 1561 </tag-name>
1687 <tag-desc> 1562 <tag-desc>
1688 The total number of client requests received from clients. 1563 The total number of client requests received from clients.
1689 </tag-desc> 1564 </tag-desc>
1690 <tag-name> 1565 <tag-name>
1691 <literal>responses</literal></tag-name> 1566 <literal>responses</literal></tag-name>
1692 <tag-desc> 1567 <tag-desc>
1693 The total number of responses sent to clients and the 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">
1694 number of responses with status codes
1695 “<literal>1xx</literal>”, “<literal>2xx</literal>”, “<literal>3xx</literal>”,
1696 “<literal>4xx</literal>”, and “<literal>5xx</literal>”.<list type="tag">
1697 <tag-name> 1569 <tag-name>
1698 <literal>1xx</literal> (<literal>integer</literal>) 1570 <literal>1xx</literal> (<literal>integer</literal>)
1699 </tag-name> 1571 </tag-name>
1700 <tag-desc> 1572 <tag-desc>
1701 The number of responses with “<literal>1xx</literal>” status codes. 1573 The number of responses with “<literal>1xx</literal>” status codes.
1734 </tag-desc> 1606 </tag-desc>
1735 <tag-name> 1607 <tag-name>
1736 <literal>discarded</literal> (<literal>integer</literal>) 1608 <literal>discarded</literal> (<literal>integer</literal>)
1737 </tag-name> 1609 </tag-name>
1738 <tag-desc> 1610 <tag-desc>
1739 The total number of 1611 The total number of requests completed without sending a response.
1740 requests completed without sending a response.
1741 </tag-desc> 1612 </tag-desc>
1742 <tag-name> 1613 <tag-name>
1743 <literal>received</literal> (<literal>integer</literal>) 1614 <literal>received</literal> (<literal>integer</literal>)
1744 </tag-name> 1615 </tag-name>
1745 <tag-desc> 1616 <tag-desc>
1781 </tag-desc> 1652 </tag-desc>
1782 <tag-name> 1653 <tag-name>
1783 <literal>max_size</literal> (<literal>integer</literal>) 1654 <literal>max_size</literal> (<literal>integer</literal>)
1784 </tag-name> 1655 </tag-name>
1785 <tag-desc> 1656 <tag-desc>
1786 The limit on the maximum size of the cache 1657 The limit on the maximum size of the cache specified in the configuration.
1787 specified in the configuration.
1788 </tag-desc> 1658 </tag-desc>
1789 <tag-name> 1659 <tag-name>
1790 <literal>cold</literal> (<literal>boolean</literal>) 1660 <literal>cold</literal> (<literal>boolean</literal>)
1791 </tag-name> 1661 </tag-name>
1792 <tag-desc> 1662 <tag-desc>
1793 A boolean value indicating whether the “cache loader” process 1663 A boolean value indicating whether the “cache loader” process is still loading data from disk into the cache.
1794 is still loading data from disk into the cache.
1795 </tag-desc> 1664 </tag-desc>
1796 <tag-name> 1665 <tag-name>
1797 <literal>hit</literal></tag-name> 1666 <literal>hit</literal></tag-name>
1798 <tag-desc> 1667 <tag-desc>
1799 <list type="tag"> 1668 <list type="tag">
1800 <tag-name> 1669 <tag-name>
1801 <literal>responses</literal> (<literal>integer</literal>) 1670 <literal>responses</literal> (<literal>integer</literal>)
1802 </tag-name> 1671 </tag-name>
1803 <tag-desc> 1672 <tag-desc>
1804 The total number of 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.
1805 <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_valid">valid</link>
1806 responses read from the cache.
1807 </tag-desc> 1674 </tag-desc>
1808 <tag-name> 1675 <tag-name>
1809 <literal>bytes</literal> (<literal>integer</literal>) 1676 <literal>bytes</literal> (<literal>integer</literal>)
1810 </tag-name> 1677 </tag-name>
1811 <tag-desc> 1678 <tag-desc>
1819 <list type="tag"> 1686 <list type="tag">
1820 <tag-name> 1687 <tag-name>
1821 <literal>responses</literal> (<literal>integer</literal>) 1688 <literal>responses</literal> (<literal>integer</literal>)
1822 </tag-name> 1689 </tag-name>
1823 <tag-desc> 1690 <tag-desc>
1824 The total number of expired responses read from the cache (see 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).
1825 <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale">proxy_cache_use_stale</link>
1826 and other “<literal>*_cache_use_stale</literal>” directives).
1827 </tag-desc> 1692 </tag-desc>
1828 <tag-name> 1693 <tag-name>
1829 <literal>bytes</literal> (<literal>integer</literal>) 1694 <literal>bytes</literal> (<literal>integer</literal>)
1830 </tag-name> 1695 </tag-name>
1831 <tag-desc> 1696 <tag-desc>
1839 <list type="tag"> 1704 <list type="tag">
1840 <tag-name> 1705 <tag-name>
1841 <literal>responses</literal> (<literal>integer</literal>) 1706 <literal>responses</literal> (<literal>integer</literal>)
1842 </tag-name> 1707 </tag-name>
1843 <tag-desc> 1708 <tag-desc>
1844 The total number of expired responses read from the cache 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).
1845 while responses were being updated (see
1846 <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale_updating">proxy_cache_use_stale</link>
1847 and other “<literal>*_cache_use_stale</literal>” directives).
1848 </tag-desc> 1710 </tag-desc>
1849 <tag-name> 1711 <tag-name>
1850 <literal>bytes</literal> (<literal>integer</literal>) 1712 <literal>bytes</literal> (<literal>integer</literal>)
1851 </tag-name> 1713 </tag-name>
1852 <tag-desc> 1714 <tag-desc>
1860 <list type="tag"> 1722 <list type="tag">
1861 <tag-name> 1723 <tag-name>
1862 <literal>responses</literal> (<literal>integer</literal>) 1724 <literal>responses</literal> (<literal>integer</literal>)
1863 </tag-name> 1725 </tag-name>
1864 <tag-desc> 1726 <tag-desc>
1865 The total number of expired and revalidated responses 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.
1866 read from the cache (see
1867 <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_revalidate">proxy_cache_revalidate</link>
1868 and other “<literal>*_cache_revalidate</literal>” directives.
1869 </tag-desc> 1728 </tag-desc>
1870 <tag-name> 1729 <tag-name>
1871 <literal>bytes</literal> (<literal>integer</literal>) 1730 <literal>bytes</literal> (<literal>integer</literal>)
1872 </tag-name> 1731 </tag-name>
1873 <tag-desc> 1732 <tag-desc>
1941 <list type="tag"> 1800 <list type="tag">
1942 <tag-name> 1801 <tag-name>
1943 <literal>responses</literal> (<literal>integer</literal>) 1802 <literal>responses</literal> (<literal>integer</literal>)
1944 </tag-name> 1803 </tag-name>
1945 <tag-desc> 1804 <tag-desc>
1946 The total number of responses not looked up in the cache due to the 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.
1947 <link url="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_bypass">proxy_cache_bypass</link>
1948 and other “<literal>*_cache_bypass</literal>” directives.
1949 </tag-desc> 1806 </tag-desc>
1950 <tag-name> 1807 <tag-name>
1951 <literal>bytes</literal> (<literal>integer</literal>) 1808 <literal>bytes</literal> (<literal>integer</literal>)
1952 </tag-name> 1809 </tag-name>
1953 <tag-desc> 1810 <tag-desc>
2023 </tag-desc> 1880 </tag-desc>
2024 <tag-name> 1881 <tag-name>
2025 <literal>server</literal> (<literal>string</literal>) 1882 <literal>server</literal> (<literal>string</literal>)
2026 </tag-name> 1883 </tag-name>
2027 <tag-desc> 1884 <tag-desc>
2028 An <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">address</link> 1885 An <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">address</link> of the server.
2029 of the server.
2030 </tag-desc> 1886 </tag-desc>
2031 <tag-name> 1887 <tag-name>
2032 <literal>service</literal> (<literal>string</literal>) 1888 <literal>service</literal> (<literal>string</literal>)
2033 </tag-name> 1889 </tag-name>
2034 <tag-desc> 1890 <tag-desc>
2035 The 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.
2036 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</link>
2037 parameter value of the
2038 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</link>
2039 directive.
2040 </tag-desc> 1892 </tag-desc>
2041 <tag-name> 1893 <tag-name>
2042 <literal>name</literal> (<literal>string</literal>) 1894 <literal>name</literal> (<literal>string</literal>)
2043 </tag-name> 1895 </tag-name>
2044 <tag-desc> 1896 <tag-desc>
2045 The name of the server specified in the 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.
2046 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</link>
2047 directive.
2048 </tag-desc> 1898 </tag-desc>
2049 <tag-name> 1899 <tag-name>
2050 <literal>backup</literal> (<literal>boolean</literal>) 1900 <literal>backup</literal> (<literal>boolean</literal>)
2051 </tag-name> 1901 </tag-name>
2052 <tag-desc> 1902 <tag-desc>
2053 A boolean value indicating whether the server is a 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.
2054 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</link>
2055 server.
2056 </tag-desc> 1904 </tag-desc>
2057 <tag-name> 1905 <tag-name>
2058 <literal>weight</literal> (<literal>integer</literal>) 1906 <literal>weight</literal> (<literal>integer</literal>)
2059 </tag-name> 1907 </tag-name>
2060 <tag-desc> 1908 <tag-desc>
2061 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">Weight</link> 1909 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">Weight</link> of the server.
2062 of the server.
2063 </tag-desc> 1910 </tag-desc>
2064 <tag-name> 1911 <tag-name>
2065 <literal>state</literal> (<literal>string</literal>) 1912 <literal>state</literal> (<literal>string</literal>)
2066 </tag-name> 1913 </tag-name>
2067 <tag-desc> 1914 <tag-desc>
2068 Current state, which may be one of 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>”.
2069 “<literal>up</literal>”, “<literal>draining</literal>”, “<literal>down</literal>”,
2070 “<literal>unavail</literal>”, “<literal>checking</literal>”,
2071 and “<literal>unhealthy</literal>”.
2072 </tag-desc> 1916 </tag-desc>
2073 <tag-name> 1917 <tag-name>
2074 <literal>active</literal> (<literal>integer</literal>) 1918 <literal>active</literal> (<literal>integer</literal>)
2075 </tag-name> 1919 </tag-name>
2076 <tag-desc> 1920 <tag-desc>
2078 </tag-desc> 1922 </tag-desc>
2079 <tag-name> 1923 <tag-name>
2080 <literal>max_conns</literal> (<literal>integer</literal>) 1924 <literal>max_conns</literal> (<literal>integer</literal>)
2081 </tag-name> 1925 </tag-name>
2082 <tag-desc> 1926 <tag-desc>
2083 The 1927 The <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</link> limit for the server.
2084 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</link>
2085 limit for the server.
2086 </tag-desc> 1928 </tag-desc>
2087 <tag-name> 1929 <tag-name>
2088 <literal>requests</literal> (<literal>integer</literal>) 1930 <literal>requests</literal> (<literal>integer</literal>)
2089 </tag-name> 1931 </tag-name>
2090 <tag-desc> 1932 <tag-desc>
2146 </tag-desc> 1988 </tag-desc>
2147 <tag-name> 1989 <tag-name>
2148 <literal>fails</literal> (<literal>integer</literal>) 1990 <literal>fails</literal> (<literal>integer</literal>)
2149 </tag-name> 1991 </tag-name>
2150 <tag-desc> 1992 <tag-desc>
2151 The total number of unsuccessful attempts 1993 The total number of unsuccessful attempts to communicate with the server.
2152 to communicate with the server.
2153 </tag-desc> 1994 </tag-desc>
2154 <tag-name> 1995 <tag-name>
2155 <literal>unavail</literal> (<literal>integer</literal>) 1996 <literal>unavail</literal> (<literal>integer</literal>)
2156 </tag-name> 1997 </tag-name>
2157 <tag-desc> 1998 <tag-desc>
2158 How many times the server became unavailable for client requests 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.
2159 (state “<literal>unavail</literal>”) due to the number of unsuccessful
2160 attempts reaching the
2161 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</link>
2162 threshold.
2163 </tag-desc> 2000 </tag-desc>
2164 <tag-name> 2001 <tag-name>
2165 <literal>health_checks</literal></tag-name> 2002 <literal>health_checks</literal></tag-name>
2166 <tag-desc> 2003 <tag-desc>
2167 <list type="tag"> 2004 <list type="tag">
2168 <tag-name> 2005 <tag-name>
2169 <literal>checks</literal> (<literal>integer</literal>) 2006 <literal>checks</literal> (<literal>integer</literal>)
2170 </tag-name> 2007 </tag-name>
2171 <tag-desc> 2008 <tag-desc>
2172 The total number of 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.
2173 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#health_check">health check</link>
2174 requests made.
2175 </tag-desc> 2010 </tag-desc>
2176 <tag-name> 2011 <tag-name>
2177 <literal>fails</literal> (<literal>integer</literal>) 2012 <literal>fails</literal> (<literal>integer</literal>)
2178 </tag-name> 2013 </tag-name>
2179 <tag-desc> 2014 <tag-desc>
2181 </tag-desc> 2016 </tag-desc>
2182 <tag-name> 2017 <tag-name>
2183 <literal>unhealthy</literal> (<literal>integer</literal>) 2018 <literal>unhealthy</literal> (<literal>integer</literal>)
2184 </tag-name> 2019 </tag-name>
2185 <tag-desc> 2020 <tag-desc>
2186 How many times the server became unhealthy 2021 How many times the server became unhealthy (state “<literal>unhealthy</literal>”).
2187 (state “<literal>unhealthy</literal>”).
2188 </tag-desc> 2022 </tag-desc>
2189 <tag-name> 2023 <tag-name>
2190 <literal>last_passed</literal> (<literal>boolean</literal>) 2024 <literal>last_passed</literal> (<literal>boolean</literal>)
2191 </tag-name> 2025 </tag-name>
2192 <tag-desc> 2026 <tag-desc>
2193 Boolean indicating if the last health check request was successful 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>.
2194 and passed
2195 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#match">tests</link>.
2196 </tag-desc> 2028 </tag-desc>
2197 </list> 2029 </list>
2198 </tag-desc> 2030 </tag-desc>
2199 <tag-name> 2031 <tag-name>
2200 <literal>downtime</literal> (<literal>integer</literal>) 2032 <literal>downtime</literal> (<literal>integer</literal>)
2201 </tag-name> 2033 </tag-name>
2202 <tag-desc> 2034 <tag-desc>
2203 Total time the server was in the “<literal>unavail</literal>”, 2035 Total time the server was in the “<literal>unavail</literal>”, “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states.
2204 “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states.
2205 </tag-desc> 2036 </tag-desc>
2206 <tag-name> 2037 <tag-name>
2207 <literal>downstart</literal> (<literal>string</literal>) 2038 <literal>downstart</literal> (<literal>string</literal>)
2208 </tag-name> 2039 </tag-name>
2209 <tag-desc> 2040 <tag-desc>
2210 The time (in milliseconds since Epoch) when the server became 2041 The time (in milliseconds since Epoch) when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”.
2211 “<literal>unavail</literal>”, “<literal>checking</literal>”,
2212 or “<literal>unhealthy</literal>”.
2213 </tag-desc> 2042 </tag-desc>
2214 <tag-name> 2043 <tag-name>
2215 <literal>selected</literal> (<literal>string</literal>) 2044 <literal>selected</literal> (<literal>string</literal>)
2216 </tag-name> 2045 </tag-name>
2217 <tag-desc> 2046 <tag-desc>
2218 The time (in milliseconds since Epoch) 2047 The time (in milliseconds since Epoch) when the server was last selected to process a request.
2219 when the server was last selected to process a request.
2220 </tag-desc> 2048 </tag-desc>
2221 <tag-name> 2049 <tag-name>
2222 <literal>header_time</literal> (<literal>integer</literal>) 2050 <literal>header_time</literal> (<literal>integer</literal>)
2223 </tag-name> 2051 </tag-name>
2224 <tag-desc> 2052 <tag-desc>
2225 The average time to get the 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.
2226 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_header_time">response header</link>
2227 from the server.
2228 </tag-desc> 2054 </tag-desc>
2229 <tag-name> 2055 <tag-name>
2230 <literal>response_time</literal> (<literal>integer</literal>) 2056 <literal>response_time</literal> (<literal>integer</literal>)
2231 </tag-name> 2057 </tag-name>
2232 <tag-desc> 2058 <tag-desc>
2233 The average time to get the 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.
2234 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_response_time">full response</link>
2235 from the server.
2236 </tag-desc> 2060 </tag-desc>
2237 </list> 2061 </list>
2238 </tag-desc> 2062 </tag-desc>
2239 <tag-name> 2063 <tag-name>
2240 <literal>keepalive</literal> (<literal>integer</literal>) 2064 <literal>keepalive</literal> (<literal>integer</literal>)
2241 </tag-name> 2065 </tag-name>
2242 <tag-desc> 2066 <tag-desc>
2243 The current number of idle 2067 The current number of idle <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive">keepalive</link> connections.
2244 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive">keepalive</link>
2245 connections.
2246 </tag-desc> 2068 </tag-desc>
2247 <tag-name> 2069 <tag-name>
2248 <literal>zombies</literal> (<literal>integer</literal>) 2070 <literal>zombies</literal> (<literal>integer</literal>)
2249 </tag-name> 2071 </tag-name>
2250 <tag-desc> 2072 <tag-desc>
2251 The current number of servers removed 2073 The current number of servers removed from the group but still processing active client requests.
2252 from the group but still processing active client requests.
2253 </tag-desc> 2074 </tag-desc>
2254 <tag-name> 2075 <tag-name>
2255 <literal>zone</literal> (<literal>string</literal>) 2076 <literal>zone</literal> (<literal>string</literal>)
2256 </tag-name> 2077 </tag-name>
2257 <tag-desc> 2078 <tag-desc>
2258 The name of the shared memory 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.
2259 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">zone</link>
2260 that keeps the group’s configuration and run-time state.
2261 </tag-desc> 2080 </tag-desc>
2262 <tag-name> 2081 <tag-name>
2263 <literal>queue</literal></tag-name> 2082 <literal>queue</literal></tag-name>
2264 <tag-desc> 2083 <tag-desc>
2265 For the requests 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">
2266 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue">queue</link>,
2267 the following data are provided:<list type="tag">
2268 <tag-name> 2085 <tag-name>
2269 <literal>size</literal> (<literal>integer</literal>) 2086 <literal>size</literal> (<literal>integer</literal>)
2270 </tag-name> 2087 </tag-name>
2271 <tag-desc> 2088 <tag-desc>
2272 The current number of requests in the queue. 2089 The current number of requests in the queue.
2273 </tag-desc> 2090 </tag-desc>
2274 <tag-name> 2091 <tag-name>
2275 <literal>max_size</literal> (<literal>integer</literal>) 2092 <literal>max_size</literal> (<literal>integer</literal>)
2276 </tag-name> 2093 </tag-name>
2277 <tag-desc> 2094 <tag-desc>
2278 The maximum number of requests that can be in the queue 2095 The maximum number of requests that can be in the queue at the same time.
2279 at the same time.
2280 </tag-desc> 2096 </tag-desc>
2281 <tag-name> 2097 <tag-name>
2282 <literal>overflows</literal> (<literal>integer</literal>) 2098 <literal>overflows</literal> (<literal>integer</literal>)
2283 </tag-name> 2099 </tag-name>
2284 <tag-desc> 2100 <tag-desc>
2371 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</link>:<list type="tag"> 2187 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</link>:<list type="tag">
2372 <tag-name> 2188 <tag-name>
2373 <literal>id</literal> (<literal>integer</literal>) 2189 <literal>id</literal> (<literal>integer</literal>)
2374 </tag-name> 2190 </tag-name>
2375 <tag-desc> 2191 <tag-desc>
2376 The ID of the HTTP upstream server. 2192 The ID of the HTTP upstream server. The ID is assigned automatically and cannot be changed.
2377 The ID is assigned automatically and cannot be changed.
2378 </tag-desc> 2193 </tag-desc>
2379 <tag-name> 2194 <tag-name>
2380 <literal>server</literal> (<literal>string</literal>) 2195 <literal>server</literal> (<literal>string</literal>)
2381 </tag-name> 2196 </tag-name>
2382 <tag-desc> 2197 <tag-desc>
2383 Same as the 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.
2384 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#address">address</link>
2385 parameter of the HTTP upstream server.
2386 When adding a server, it is possible to specify it as a domain name.
2387 In this case, changes of the IP addresses
2388 that correspond to a domain name will be monitored and automatically
2389 applied to the upstream configuration
2390 without the need of restarting nginx.
2391 This requires the
2392 <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver">resolver</link>
2393 directive in the “<literal>http</literal>” block.
2394 See also the
2395 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#resolve">resolve</link>
2396 parameter of the HTTP upstream server.
2397 </tag-desc> 2199 </tag-desc>
2398 <tag-name> 2200 <tag-name>
2399 <literal>service</literal> (<literal>string</literal>) 2201 <literal>service</literal> (<literal>string</literal>)
2400 </tag-name> 2202 </tag-name>
2401 <tag-desc> 2203 <tag-desc>
2402 Same as the 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.
2403 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</link>
2404 parameter of the HTTP upstream server.
2405 This parameter cannot be changed.
2406 </tag-desc> 2205 </tag-desc>
2407 <tag-name> 2206 <tag-name>
2408 <literal>weight</literal> (<literal>integer</literal>) 2207 <literal>weight</literal> (<literal>integer</literal>)
2409 </tag-name> 2208 </tag-name>
2410 <tag-desc> 2209 <tag-desc>
2411 Same as the 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.
2412 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">weight</link>
2413 parameter of the HTTP upstream server.
2414 </tag-desc> 2211 </tag-desc>
2415 <tag-name> 2212 <tag-name>
2416 <literal>max_conns</literal> (<literal>integer</literal>) 2213 <literal>max_conns</literal> (<literal>integer</literal>)
2417 </tag-name> 2214 </tag-name>
2418 <tag-desc> 2215 <tag-desc>
2419 Same as the 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.
2420 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</link>
2421 parameter of the HTTP upstream server.
2422 </tag-desc> 2217 </tag-desc>
2423 <tag-name> 2218 <tag-name>
2424 <literal>max_fails</literal> (<literal>integer</literal>) 2219 <literal>max_fails</literal> (<literal>integer</literal>)
2425 </tag-name> 2220 </tag-name>
2426 <tag-desc> 2221 <tag-desc>
2427 Same as the 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.
2428 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</link>
2429 parameter of the HTTP upstream server.
2430 </tag-desc> 2223 </tag-desc>
2431 <tag-name> 2224 <tag-name>
2432 <literal>fail_timeout</literal> (<literal>integer</literal>) 2225 <literal>fail_timeout</literal> (<literal>integer</literal>)
2433 </tag-name> 2226 </tag-name>
2434 <tag-desc> 2227 <tag-desc>
2435 Same as the 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.
2436 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#fail_timeout">fail_timeout</link>
2437 parameter of the HTTP upstream server.
2438 </tag-desc> 2229 </tag-desc>
2439 <tag-name> 2230 <tag-name>
2440 <literal>slow_start</literal> (<literal>integer</literal>) 2231 <literal>slow_start</literal> (<literal>integer</literal>)
2441 </tag-name> 2232 </tag-name>
2442 <tag-desc> 2233 <tag-desc>
2443 Same as the 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.
2444 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#slow_start">slow_start</link>
2445 parameter of the HTTP upstream server.
2446 </tag-desc> 2235 </tag-desc>
2447 <tag-name> 2236 <tag-name>
2448 <literal>route</literal> (<literal>string</literal>) 2237 <literal>route</literal> (<literal>string</literal>)
2449 </tag-name> 2238 </tag-name>
2450 <tag-desc> 2239 <tag-desc>
2451 Same as the 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.
2452 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#route">route</link>
2453 parameter of the HTTP upstream server.
2454 </tag-desc> 2241 </tag-desc>
2455 <tag-name> 2242 <tag-name>
2456 <literal>backup</literal> (<literal>boolean</literal>) 2243 <literal>backup</literal> (<literal>boolean</literal>)
2457 </tag-name> 2244 </tag-name>
2458 <tag-desc> 2245 <tag-desc>
2459 When <literal>true</literal>, adds a 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.
2460 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</link>
2461 server.
2462 This parameter cannot be changed.
2463 </tag-desc> 2247 </tag-desc>
2464 <tag-name> 2248 <tag-name>
2465 <literal>down</literal> (<literal>boolean</literal>) 2249 <literal>down</literal> (<literal>boolean</literal>)
2466 </tag-name> 2250 </tag-name>
2467 <tag-desc> 2251 <tag-desc>
2468 Same as the 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.
2469 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#down">down</link>
2470 parameter of the HTTP upstream server.
2471 </tag-desc> 2253 </tag-desc>
2472 <tag-name> 2254 <tag-name>
2473 <literal>parent</literal> (<literal>string</literal>) 2255 <literal>parent</literal> (<literal>string</literal>)
2474 </tag-name> 2256 </tag-name>
2475 <tag-desc> 2257 <tag-desc>
2476 Parent server ID of the resolved server. 2258 Parent server ID of the resolved server. The ID is assigned automatically and cannot be changed.
2477 The ID is assigned automatically and cannot be changed.
2478 </tag-desc> 2259 </tag-desc>
2479 <tag-name> 2260 <tag-name>
2480 <literal>host</literal> (<literal>string</literal>) 2261 <literal>host</literal> (<literal>string</literal>)
2481 </tag-name> 2262 </tag-name>
2482 <tag-desc> 2263 <tag-desc>
2483 Hostname of the resolved server. 2264 Hostname of the resolved server. The hostname is assigned automatically and cannot be changed.
2484 The hostname is assigned automatically and cannot be changed.
2485 </tag-desc> 2265 </tag-desc>
2486 <tag-name> 2266 <tag-name>
2487 <literal>drain</literal> (<literal>string</literal>) 2267 <literal>drain</literal> (<literal>string</literal>)
2488 </tag-name> 2268 </tag-name>
2489 <tag-desc> 2269 <tag-desc>
2490 Puts the HTTP upstream server into the “draining” mode. 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.
2491 In this mode, only requests
2492 <link url="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#sticky">bound</link>
2493 to the server will be proxied to it.
2494 The parameter cannot be initially set,
2495 it can only be changed with the <literal>PATCH</literal> method.
2496 </tag-desc> 2271 </tag-desc>
2497 </list> 2272 </list>
2498 <para>Example:</para> 2273 <para>Example:</para>
2499 <example> 2274 <example>
2500 { 2275 {
2525 <list type="tag"> 2300 <list type="tag">
2526 <tag-name> 2301 <tag-name>
2527 <literal>processing</literal> (<literal>integer</literal>) 2302 <literal>processing</literal> (<literal>integer</literal>)
2528 </tag-name> 2303 </tag-name>
2529 <tag-desc> 2304 <tag-desc>
2530 The number of client connections 2305 The number of client connections that are currently being processed.
2531 that are currently being processed.
2532 </tag-desc> 2306 </tag-desc>
2533 <tag-name> 2307 <tag-name>
2534 <literal>connections</literal> (<literal>integer</literal>) 2308 <literal>connections</literal> (<literal>integer</literal>)
2535 </tag-name> 2309 </tag-name>
2536 <tag-desc> 2310 <tag-desc>
2537 The total number of connections accepted from clients. 2311 The total number of connections accepted from clients.
2538 </tag-desc> 2312 </tag-desc>
2539 <tag-name> 2313 <tag-name>
2540 <literal>sessions</literal></tag-name> 2314 <literal>sessions</literal></tag-name>
2541 <tag-desc> 2315 <tag-desc>
2542 Total number of completed sessions, 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">
2543 and the number of sessions completed with status codes
2544 “<literal>2xx</literal>”, “<literal>4xx</literal>”, or “<literal>5xx</literal>”.<list type="tag">
2545 <tag-name> 2317 <tag-name>
2546 <literal>2xx</literal> (<literal>integer</literal>) 2318 <literal>2xx</literal> (<literal>integer</literal>)
2547 </tag-name> 2319 </tag-name>
2548 <tag-desc> 2320 <tag-desc>
2549 The total number of sessions completed with 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>”.
2550 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</link>
2551 “<literal>2xx</literal>”.
2552 </tag-desc> 2322 </tag-desc>
2553 <tag-name> 2323 <tag-name>
2554 <literal>4xx</literal> (<literal>integer</literal>) 2324 <literal>4xx</literal> (<literal>integer</literal>)
2555 </tag-name> 2325 </tag-name>
2556 <tag-desc> 2326 <tag-desc>
2557 The total number of sessions completed with 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>”.
2558 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</link>
2559 “<literal>4xx</literal>”.
2560 </tag-desc> 2328 </tag-desc>
2561 <tag-name> 2329 <tag-name>
2562 <literal>5xx</literal> (<literal>integer</literal>) 2330 <literal>5xx</literal> (<literal>integer</literal>)
2563 </tag-name> 2331 </tag-name>
2564 <tag-desc> 2332 <tag-desc>
2565 The total number of sessions completed with 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>”.
2566 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</link>
2567 “<literal>5xx</literal>”.
2568 </tag-desc> 2334 </tag-desc>
2569 <tag-name> 2335 <tag-name>
2570 <literal>total</literal> (<literal>integer</literal>) 2336 <literal>total</literal> (<literal>integer</literal>)
2571 </tag-name> 2337 </tag-name>
2572 <tag-desc> 2338 <tag-desc>
2576 </tag-desc> 2342 </tag-desc>
2577 <tag-name> 2343 <tag-name>
2578 <literal>discarded</literal> (<literal>integer</literal>) 2344 <literal>discarded</literal> (<literal>integer</literal>)
2579 </tag-name> 2345 </tag-name>
2580 <tag-desc> 2346 <tag-desc>
2581 The total number of 2347 The total number of connections completed without creating a session.
2582 connections completed without creating a session.
2583 </tag-desc> 2348 </tag-desc>
2584 <tag-name> 2349 <tag-name>
2585 <literal>received</literal> (<literal>integer</literal>) 2350 <literal>received</literal> (<literal>integer</literal>)
2586 </tag-name> 2351 </tag-name>
2587 <tag-desc> 2352 <tag-desc>
2627 </tag-desc> 2392 </tag-desc>
2628 <tag-name> 2393 <tag-name>
2629 <literal>server</literal> (<literal>string</literal>) 2394 <literal>server</literal> (<literal>string</literal>)
2630 </tag-name> 2395 </tag-name>
2631 <tag-desc> 2396 <tag-desc>
2632 An 2397 An <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</link> of the server.
2633 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</link>
2634 of the server.
2635 </tag-desc> 2398 </tag-desc>
2636 <tag-name> 2399 <tag-name>
2637 <literal>service</literal> (<literal>string</literal>) 2400 <literal>service</literal> (<literal>string</literal>)
2638 </tag-name> 2401 </tag-name>
2639 <tag-desc> 2402 <tag-desc>
2640 The 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.
2641 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</link>
2642 parameter value of the
2643 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</link>
2644 directive.
2645 </tag-desc> 2404 </tag-desc>
2646 <tag-name> 2405 <tag-name>
2647 <literal>name</literal> (<literal>string</literal>) 2406 <literal>name</literal> (<literal>string</literal>)
2648 </tag-name> 2407 </tag-name>
2649 <tag-desc> 2408 <tag-desc>
2650 The name of the server specified in the 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.
2651 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</link>
2652 directive.
2653 </tag-desc> 2410 </tag-desc>
2654 <tag-name> 2411 <tag-name>
2655 <literal>backup</literal> (<literal>boolean</literal>) 2412 <literal>backup</literal> (<literal>boolean</literal>)
2656 </tag-name> 2413 </tag-name>
2657 <tag-desc> 2414 <tag-desc>
2658 A boolean value indicating whether the server is a 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.
2659 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</link>
2660 server.
2661 </tag-desc> 2416 </tag-desc>
2662 <tag-name> 2417 <tag-name>
2663 <literal>weight</literal> (<literal>integer</literal>) 2418 <literal>weight</literal> (<literal>integer</literal>)
2664 </tag-name> 2419 </tag-name>
2665 <tag-desc> 2420 <tag-desc>
2666 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">Weight</link> 2421 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">Weight</link> of the server.
2667 of the server.
2668 </tag-desc> 2422 </tag-desc>
2669 <tag-name> 2423 <tag-name>
2670 <literal>state</literal> (<literal>string</literal>) 2424 <literal>state</literal> (<literal>string</literal>)
2671 </tag-name> 2425 </tag-name>
2672 <tag-desc> 2426 <tag-desc>
2673 Current state, which may be one of 2427 Current state, which may be one of “<literal>up</literal>”, “<literal>down</literal>”, “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”.
2674 “<literal>up</literal>”, “<literal>down</literal>”, “<literal>unavail</literal>”,
2675 “<literal>checking</literal>”, or “<literal>unhealthy</literal>”.
2676 </tag-desc> 2428 </tag-desc>
2677 <tag-name> 2429 <tag-name>
2678 <literal>active</literal> (<literal>integer</literal>) 2430 <literal>active</literal> (<literal>integer</literal>)
2679 </tag-name> 2431 </tag-name>
2680 <tag-desc> 2432 <tag-desc>
2682 </tag-desc> 2434 </tag-desc>
2683 <tag-name> 2435 <tag-name>
2684 <literal>max_conns</literal> (<literal>integer</literal>) 2436 <literal>max_conns</literal> (<literal>integer</literal>)
2685 </tag-name> 2437 </tag-name>
2686 <tag-desc> 2438 <tag-desc>
2687 The 2439 The <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</link> limit for the server.
2688 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</link>
2689 limit for the server.
2690 </tag-desc> 2440 </tag-desc>
2691 <tag-name> 2441 <tag-name>
2692 <literal>connections</literal> (<literal>integer</literal>) 2442 <literal>connections</literal> (<literal>integer</literal>)
2693 </tag-name> 2443 </tag-name>
2694 <tag-desc> 2444 <tag-desc>
2726 </tag-desc> 2476 </tag-desc>
2727 <tag-name> 2477 <tag-name>
2728 <literal>fails</literal> (<literal>integer</literal>) 2478 <literal>fails</literal> (<literal>integer</literal>)
2729 </tag-name> 2479 </tag-name>
2730 <tag-desc> 2480 <tag-desc>
2731 The total number of unsuccessful attempts 2481 The total number of unsuccessful attempts to communicate with the server.
2732 to communicate with the server.
2733 </tag-desc> 2482 </tag-desc>
2734 <tag-name> 2483 <tag-name>
2735 <literal>unavail</literal> (<literal>integer</literal>) 2484 <literal>unavail</literal> (<literal>integer</literal>)
2736 </tag-name> 2485 </tag-name>
2737 <tag-desc> 2486 <tag-desc>
2738 How many times the server became unavailable for client connections 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.
2739 (state “<literal>unavail</literal>”) due to the number of unsuccessful
2740 attempts reaching the
2741 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</link>
2742 threshold.
2743 </tag-desc> 2488 </tag-desc>
2744 <tag-name> 2489 <tag-name>
2745 <literal>health_checks</literal></tag-name> 2490 <literal>health_checks</literal></tag-name>
2746 <tag-desc> 2491 <tag-desc>
2747 <list type="tag"> 2492 <list type="tag">
2748 <tag-name> 2493 <tag-name>
2749 <literal>checks</literal> (<literal>integer</literal>) 2494 <literal>checks</literal> (<literal>integer</literal>)
2750 </tag-name> 2495 </tag-name>
2751 <tag-desc> 2496 <tag-desc>
2752 The total number of 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.
2753 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#health_check">health check</link>
2754 requests made.
2755 </tag-desc> 2498 </tag-desc>
2756 <tag-name> 2499 <tag-name>
2757 <literal>fails</literal> (<literal>integer</literal>) 2500 <literal>fails</literal> (<literal>integer</literal>)
2758 </tag-name> 2501 </tag-name>
2759 <tag-desc> 2502 <tag-desc>
2761 </tag-desc> 2504 </tag-desc>
2762 <tag-name> 2505 <tag-name>
2763 <literal>unhealthy</literal> (<literal>integer</literal>) 2506 <literal>unhealthy</literal> (<literal>integer</literal>)
2764 </tag-name> 2507 </tag-name>
2765 <tag-desc> 2508 <tag-desc>
2766 How many times the server became unhealthy 2509 How many times the server became unhealthy (state “<literal>unhealthy</literal>”).
2767 (state “<literal>unhealthy</literal>”).
2768 </tag-desc> 2510 </tag-desc>
2769 <tag-name> 2511 <tag-name>
2770 <literal>last_passed</literal> (<literal>boolean</literal>) 2512 <literal>last_passed</literal> (<literal>boolean</literal>)
2771 </tag-name> 2513 </tag-name>
2772 <tag-desc> 2514 <tag-desc>
2773 Boolean indicating whether the last health check request 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>.
2774 was successful and passed
2775 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#match">tests</link>.
2776 </tag-desc> 2516 </tag-desc>
2777 </list> 2517 </list>
2778 </tag-desc> 2518 </tag-desc>
2779 <tag-name> 2519 <tag-name>
2780 <literal>downtime</literal> (<literal>integer</literal>) 2520 <literal>downtime</literal> (<literal>integer</literal>)
2781 </tag-name> 2521 </tag-name>
2782 <tag-desc> 2522 <tag-desc>
2783 Total time the server was in the 2523 Total time the server was in the “<literal>unavail</literal>”, “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states.
2784 “<literal>unavail</literal>”, “<literal>checking</literal>”,
2785 and “<literal>unhealthy</literal>” states.
2786 </tag-desc> 2524 </tag-desc>
2787 <tag-name> 2525 <tag-name>
2788 <literal>downstart</literal> (<literal>string</literal>) 2526 <literal>downstart</literal> (<literal>string</literal>)
2789 </tag-name> 2527 </tag-name>
2790 <tag-desc> 2528 <tag-desc>
2791 The time (in milliseconds since Epoch) when the server became 2529 The time (in milliseconds since Epoch) when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”.
2792 “<literal>unavail</literal>”, “<literal>checking</literal>”,
2793 or “<literal>unhealthy</literal>”.
2794 </tag-desc> 2530 </tag-desc>
2795 <tag-name> 2531 <tag-name>
2796 <literal>selected</literal> (<literal>string</literal>) 2532 <literal>selected</literal> (<literal>string</literal>)
2797 </tag-name> 2533 </tag-name>
2798 <tag-desc> 2534 <tag-desc>
2799 The time (in milliseconds since Epoch) 2535 The time (in milliseconds since Epoch) when the server was last selected to process a connection.
2800 when the server was last selected to process a connection.
2801 </tag-desc> 2536 </tag-desc>
2802 </list> 2537 </list>
2803 </tag-desc> 2538 </tag-desc>
2804 <tag-name> 2539 <tag-name>
2805 <literal>zombies</literal> (<literal>integer</literal>) 2540 <literal>zombies</literal> (<literal>integer</literal>)
2806 </tag-name> 2541 </tag-name>
2807 <tag-desc> 2542 <tag-desc>
2808 The current number of servers removed from the group 2543 The current number of servers removed from the group but still processing active client connections.
2809 but still processing active client connections.
2810 </tag-desc> 2544 </tag-desc>
2811 <tag-name> 2545 <tag-name>
2812 <literal>zone</literal> (<literal>string</literal>) 2546 <literal>zone</literal> (<literal>string</literal>)
2813 </tag-name> 2547 </tag-name>
2814 <tag-desc> 2548 <tag-desc>
2815 The name of the shared memory 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.
2816 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#zone">zone</link>
2817 that keeps the group’s configuration and run-time state.
2818 </tag-desc> 2550 </tag-desc>
2819 </list> 2551 </list>
2820 <para>Example:</para> 2552 <para>Example:</para>
2821 <example> 2553 <example>
2822 { 2554 {
2882 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</link>:<list type="tag"> 2614 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</link>:<list type="tag">
2883 <tag-name> 2615 <tag-name>
2884 <literal>id</literal> (<literal>integer</literal>) 2616 <literal>id</literal> (<literal>integer</literal>)
2885 </tag-name> 2617 </tag-name>
2886 <tag-desc> 2618 <tag-desc>
2887 The ID of the stream upstream server. 2619 The ID of the stream upstream server. The ID is assigned automatically and cannot be changed.
2888 The ID is assigned automatically and cannot be changed.
2889 </tag-desc> 2620 </tag-desc>
2890 <tag-name> 2621 <tag-name>
2891 <literal>server</literal> (<literal>string</literal>) 2622 <literal>server</literal> (<literal>string</literal>)
2892 </tag-name> 2623 </tag-name>
2893 <tag-desc> 2624 <tag-desc>
2894 Same as the 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.
2895 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</link>
2896 parameter of the stream upstream server.
2897 When adding a server, it is possible to specify it as a domain name.
2898 In this case, changes of the IP addresses
2899 that correspond to a domain name will be monitored and automatically
2900 applied to the upstream configuration
2901 without the need of restarting nginx.
2902 This requires the
2903 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#resolver">resolver</link>
2904 directive in the “<literal>stream</literal>” block.
2905 See also the
2906 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#resolve">resolve</link>
2907 parameter of the stream upstream server.
2908 </tag-desc> 2626 </tag-desc>
2909 <tag-name> 2627 <tag-name>
2910 <literal>service</literal> (<literal>string</literal>) 2628 <literal>service</literal> (<literal>string</literal>)
2911 </tag-name> 2629 </tag-name>
2912 <tag-desc> 2630 <tag-desc>
2913 Same as the 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.
2914 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</link>
2915 parameter of the stream upstream server.
2916 This parameter cannot be changed.
2917 </tag-desc> 2632 </tag-desc>
2918 <tag-name> 2633 <tag-name>
2919 <literal>weight</literal> (<literal>integer</literal>) 2634 <literal>weight</literal> (<literal>integer</literal>)
2920 </tag-name> 2635 </tag-name>
2921 <tag-desc> 2636 <tag-desc>
2922 Same as the 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.
2923 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">weight</link>
2924 parameter of the stream upstream server.
2925 </tag-desc> 2638 </tag-desc>
2926 <tag-name> 2639 <tag-name>
2927 <literal>max_conns</literal> (<literal>integer</literal>) 2640 <literal>max_conns</literal> (<literal>integer</literal>)
2928 </tag-name> 2641 </tag-name>
2929 <tag-desc> 2642 <tag-desc>
2930 Same as the 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.
2931 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</link>
2932 parameter of the stream upstream server.
2933 </tag-desc> 2644 </tag-desc>
2934 <tag-name> 2645 <tag-name>
2935 <literal>max_fails</literal> (<literal>integer</literal>) 2646 <literal>max_fails</literal> (<literal>integer</literal>)
2936 </tag-name> 2647 </tag-name>
2937 <tag-desc> 2648 <tag-desc>
2938 Same as the 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.
2939 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</link>
2940 parameter of the stream upstream server.
2941 </tag-desc> 2650 </tag-desc>
2942 <tag-name> 2651 <tag-name>
2943 <literal>fail_timeout</literal> (<literal>integer</literal>) 2652 <literal>fail_timeout</literal> (<literal>integer</literal>)
2944 </tag-name> 2653 </tag-name>
2945 <tag-desc> 2654 <tag-desc>
2946 Same as the 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.
2947 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#fail_timeout">fail_timeout</link>
2948 parameter of the stream upstream server.
2949 </tag-desc> 2656 </tag-desc>
2950 <tag-name> 2657 <tag-name>
2951 <literal>slow_start</literal> (<literal>integer</literal>) 2658 <literal>slow_start</literal> (<literal>integer</literal>)
2952 </tag-name> 2659 </tag-name>
2953 <tag-desc> 2660 <tag-desc>
2954 Same as the 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.
2955 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#slow_start">slow_start</link>
2956 parameter of the stream upstream server.
2957 </tag-desc> 2662 </tag-desc>
2958 <tag-name> 2663 <tag-name>
2959 <literal>backup</literal> (<literal>boolean</literal>) 2664 <literal>backup</literal> (<literal>boolean</literal>)
2960 </tag-name> 2665 </tag-name>
2961 <tag-desc> 2666 <tag-desc>
2962 When <literal>true</literal>, adds a 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.
2963 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</link>
2964 server.
2965 This parameter cannot be changed.
2966 </tag-desc> 2668 </tag-desc>
2967 <tag-name> 2669 <tag-name>
2968 <literal>down</literal> (<literal>boolean</literal>) 2670 <literal>down</literal> (<literal>boolean</literal>)
2969 </tag-name> 2671 </tag-name>
2970 <tag-desc> 2672 <tag-desc>
2971 Same as the 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.
2972 <link url="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#down">down</link>
2973 parameter of the stream upstream server.
2974 </tag-desc> 2674 </tag-desc>
2975 <tag-name> 2675 <tag-name>
2976 <literal>parent</literal> (<literal>string</literal>) 2676 <literal>parent</literal> (<literal>string</literal>)
2977 </tag-name> 2677 </tag-name>
2978 <tag-desc> 2678 <tag-desc>
2979 Parent server ID of the resolved server. 2679 Parent server ID of the resolved server. The ID is assigned automatically and cannot be changed.
2980 The ID is assigned automatically and cannot be changed.
2981 </tag-desc> 2680 </tag-desc>
2982 <tag-name> 2681 <tag-name>
2983 <literal>host</literal> (<literal>string</literal>) 2682 <literal>host</literal> (<literal>string</literal>)
2984 </tag-name> 2683 </tag-name>
2985 <tag-desc> 2684 <tag-desc>
2986 Hostname of the resolved server. 2685 Hostname of the resolved server. The hostname is assigned automatically and cannot be changed.
2987 The hostname is assigned automatically and cannot be changed.
2988 </tag-desc> 2686 </tag-desc>
2989 </list> 2687 </list>
2990 <para>Example:</para> 2688 <para>Example:</para>
2991 <example> 2689 <example>
2992 { 2690 {
3042 </tag-desc> 2740 </tag-desc>
3043 <tag-name> 2741 <tag-name>
3044 <literal>request_id</literal> (<literal>string</literal>) 2742 <literal>request_id</literal> (<literal>string</literal>)
3045 </tag-name> 2743 </tag-name>
3046 <tag-desc> 2744 <tag-desc>
3047 The ID of the request, equals the value of the 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.
3048 <link url="https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id">$request_id</link>
3049 variable.
3050 </tag-desc> 2746 </tag-desc>
3051 <tag-name> 2747 <tag-name>
3052 <literal>href</literal> (<literal>string</literal>) 2748 <literal>href</literal> (<literal>string</literal>)
3053 </tag-name> 2749 </tag-name>
3054 <tag-desc> 2750 <tag-desc>