Mercurial > hg > nginx-site

comparison yaml/nginx_api.yaml @ 2028:5c55b7054b58

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Sat, 26 Aug 2017 00:56:05 +0300
parents
children a810103f8a75
comparison
equal deleted inserted replaced
2027:dabca59da4ce 2028:5c55b7054b58
1 swagger: '2.0'
2 info:
3 version: '1.0'
4 title: NGINX Plus REST API
5 description: |
6 NGINX Plus REST
7 [API](https://nginx.org/en/docs/http/ngx_http_api_module.html)
8 provides access to NGINX Plus status information,
9 on-the-fly configuration of upstream servers and
10 [key-value](https://nginx.org/en/docs/http/ngx_http_keyval_module.html)
11 pairs management.
12 basePath: /api/1
13 tags:
14 - name: General Info
15 - name: Processes
16 - name: Connections
17 - name: SSL
18 - name: Slabs
19 - name: HTTP
20 - name: HTTP Requests
21 - name: HTTP Caches
22 - name: HTTP Server Zones
23 - name: HTTP Upstreams
24 - name: HTTP Keyvals
25 - name: Stream
26 - name: Stream Server Zones
27 - name: Stream Upstreams
28 - name: Method GET
29 - name: Method POST
30 - name: Method PATCH
31 - name: Method DELETE
32 schemes:
33 - http
34 paths:
35 /:
36 get:
37 tags:
38 - General Info
39 - Method GET
40 summary: |
41 Return list of root endpoints
42 description: |
43 Returns a list of root endpoints.
44 operationId: getAPIEndpoints
45 produces:
46 - application/json
47 responses:
48 '200':
49 description: Success
50 schema:
51 $ref: '#/definitions/ArrayOfStrings'
52 /nginx:
53 get:
54 tags:
55 - General Info
56 - Method GET
57 summary: |
58 Return status of nginx running instance
59 description: |
60 Returns nginx version, build name, address,
61 number of configuration reloads, IDs of master and worker processes.
62 operationId: getNginx
63 produces:
64 - application/json
65 parameters:
66 - in: query
67 name: fields
68 type: string
69 description: |
70 Limits which fields of nginx running instance will be output.
71 responses:
72 '200':
73 description: Success
74 schema:
75 $ref: '#/definitions/NginxObject'
76 /processes:
77 get:
78 tags:
79 - Processes
80 - Method GET
81 summary: |
82 Return nginx processes status
83 description: |
84 Returns the number of abnormally terminated
85 and respawned child processes.
86 operationId: getProcesses
87 produces:
88 - application/json
89 responses:
90 '200':
91 description: Success
92 schema:
93 $ref: '#/definitions/NginxProcesses'
94 delete:
95 tags:
96 - Processes
97 - Method DELETE
98 summary: |
99 Reset nginx processes statistics
100 description: |
101 Resets counters of abnormally terminated and respawned
102 child processes.
103 operationId: deleteProcesses
104 responses:
105 '204':
106 description: Success
107 /connections:
108 get:
109 tags:
110 - Connections
111 - Method GET
112 summary: |
113 Return client connections statistics
114 description: |
115 Returns statistics of client connections.
116 operationId: getConnections
117 produces:
118 - application/json
119 responses:
120 '200':
121 description: Success
122 schema:
123 $ref: '#/definitions/NginxConnections'
124 parameters:
125 - in: query
126 name: fields
127 type: string
128 description: |
129 Limits which fields of the connections statistics will be output.
130 delete:
131 tags:
132 - Connections
133 - Method DELETE
134 summary: |
135 Reset client connections statistics
136 description: |
137 Resets statistics of accepted and dropped
138 client connections.
139 operationId: deleteConnections
140 responses:
141 '204':
142 description: Success
143 /ssl:
144 get:
145 tags:
146 - SSL
147 - Method GET
148 summary: |
149 Return SSL statistics
150 description: |
151 Returns SSL statistics.
152 operationId: getSsl
153 produces:
154 - application/json
155 responses:
156 '200':
157 description: Success
158 schema:
159 $ref: '#/definitions/NginxSSLObject'
160 parameters:
161 - in: query
162 name: fields
163 type: string
164 description: |
165 Limits which fields of SSL statistics will be output.
166 delete:
167 tags:
168 - SSL
169 - Method DELETE
170 summary: |
171 Reset SSL statistics
172 description: |
173 Resets counters of SSL handshakes and session reuses.
174 operationId: deleteSslStat
175 responses:
176 '204':
177 description: Success
178 /slabs/:
179 get:
180 tags:
181 - Slabs
182 - Method GET
183 summary: |
184 Return status of all slabs
185 description: |
186 Returns status of slabs
187 for each shared memory zone with slab allocator.
188 operationId: getSlabs
189 produces:
190 - application/json
191 parameters:
192 - in: query
193 name: fields
194 type: string
195 description: |
196 Limits which fields of slab zones will be output.
197 If the “<literal>fields</literal>” value is empty,
198 then only zone names are output.
199 responses:
200 '200':
201 description: Success
202 schema:
203 $ref: '#/definitions/NginxSlabZoneMap'
204 '/slabs/{slabZoneName}':
205 parameters:
206 - name: slabZoneName
207 in: path
208 description: |
209 The name of the shared memory zone with slab allocator.
210 required: true
211 type: string
212 get:
213 tags:
214 - Slabs
215 - Method GET
216 summary: |
217 Return status of a slab
218 description: |
219 Returns status of slabs for a particular shared memory zone
220 with slab allocator.
221 operationId: getSlabZone
222 produces:
223 - application/json
224 parameters:
225 - in: query
226 name: fields
227 type: string
228 description: |
229 Limits which fields of the slab zone will be output.
230 responses:
231 '200':
232 description: Success
233 schema:
234 $ref: '#/definitions/NginxSlabZone'
235 '404':
236 description: Slab not found (*SlabNotFound*)
237 schema:
238 $ref: '#/definitions/NginxError'
239 delete:
240 tags:
241 - Slabs
242 - Method DELETE
243 summary: |
244 Reset slab statistics
245 description: |
246 Resets the “<literal>reqs</literal>” and “<literal>fails</literal>”
247 metrics for each memory slot.
248 operationId: deleteSlabZoneStats
249 responses:
250 '204':
251 description: Success
252 '404':
253 description: Slab not found (*SlabNotFound*)
254 schema:
255 $ref: '#/definitions/NginxError'
256 /http/:
257 get:
258 tags:
259 - HTTP
260 - Method GET
261 summary: |
262 Return list of HTTP-related endpoints
263 description: |
264 Returns a list of first level HTTP endpoints.
265 operationId: getHttp
266 produces:
267 - application/json
268 responses:
269 '200':
270 description: Success
271 schema:
272 $ref: '#/definitions/ArrayOfStrings'
273 /http/requests:
274 get:
275 tags:
276 - HTTP Requests
277 - Method GET
278 summary: |
279 Return HTTP requests statistics
280 description: |
281 Returns status of client HTTP requests.
282 operationId: getHttpRequests
283 produces:
284 - application/json
285 parameters:
286 - in: query
287 name: fields
288 type: string
289 description: |
290 Limits which fields of client HTTP requests statistics
291 will be output.
292 responses:
293 '200':
294 description: Success
295 schema:
296 $ref: '#/definitions/NginxHTTPRequests'
297 delete:
298 tags:
299 - HTTP Requests
300 - Method DELETE
301 summary: |
302 Reset HTTP requests statistics
303 description: |
304 Resets the number of total client HTTP requests.
305 operationId: deleteHttpRequests
306 responses:
307 '204':
308 description: Success
309 /http/server_zones/:
310 get:
311 tags:
312 - HTTP Server Zones
313 - Method GET
314 summary: |
315 Return status of all HTTP server zones
316 description: |
317 Returns status information for each HTTP
318 [server zone](https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone).
319 operationId: getHttpServerZones
320 produces:
321 - application/json
322 parameters:
323 - in: query
324 name: fields
325 type: string
326 description: |
327 Limits which fields of server zones will be output.
328 If the “<literal>fields</literal>” value is empty,
329 then only server zone names are output.
330 responses:
331 '200':
332 description: Success
333 schema:
334 $ref: '#/definitions/NginxHTTPServerZonesMap'
335 '/http/server_zones/{httpServerZoneName}':
336 parameters:
337 - name: httpServerZoneName
338 in: path
339 description: The name of an HTTP server zone.
340 type: string
341 required: true
342 get:
343 tags:
344 - HTTP Server Zones
345 - Method GET
346 summary: |
347 Return status of an HTTP server zone
348 description: |
349 Returns status of a particular HTTP server zone.
350 operationId: getHttpServerZone
351 produces:
352 - application/json
353 parameters:
354 - name: fields
355 in: query
356 type: string
357 description: |
358 Limits which fields of the server zone will be output.
359 responses:
360 '200':
361 description: Success
362 schema:
363 $ref: '#/definitions/NginxHTTPServerZone'
364 '404':
365 description: Server zone not found (*ServerZoneNotFound*)
366 schema:
367 $ref: '#/definitions/NginxError'
368 delete:
369 tags:
370 - HTTP Server Zones
371 - Method DELETE
372 summary: |
373 Reset statistics for an HTTP server zone
374 description: |
375 Resets statistics of accepted and discarded requests, responses,
376 received and sent bytes in a particular HTTP server zone.
377 operationId: deleteHttpServerZoneStat
378 responses:
379 '204':
380 description: Success
381 '404':
382 description: Server zone not found (*ServerZoneNotFound*)
383 schema:
384 $ref: '#/definitions/NginxError'
385 /http/caches/:
386 get:
387 tags:
388 - HTTP Caches
389 - Method GET
390 summary: |
391 Return status of all caches
392 description: |
393 Returns status of each cache configured by
394 [proxy_cache_path](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path)
395 and other “<literal>*_cache_path</literal>” directives.
396 operationId: getHttpCaches
397 produces:
398 - application/json
399 parameters:
400 - name: fields
401 in: query
402 type: string
403 description: |
404 Limits which fields of cache zones will be output.
405 If the “<literal>fields</literal>” value is empty,
406 then only names of cache zones are output.
407 responses:
408 '200':
409 description: Success
410 schema:
411 $ref: '#/definitions/NginxHTTPCachesMap'
412 '/http/caches/{httpCacheZoneName}':
413 parameters:
414 - name: httpCacheZoneName
415 in: path
416 description: |
417 The name of the cache zone.
418 type: string
419 required: true
420 get:
421 tags:
422 - HTTP Caches
423 - Method GET
424 summary: |
425 Return status of a cache
426 description: |
427 Returns status of a particular cache.
428 operationId: getHttpCacheZone
429 produces:
430 - application/json
431 parameters:
432 - name: fields
433 in: query
434 type: string
435 description: |
436 Limits which fields of the cache zone will be output.
437 responses:
438 '200':
439 description: Success
440 schema:
441 $ref: '#/definitions/NginxHTTPCache'
442 '404':
443 description: Cache not found (*CacheNotFound*)
444 schema:
445 $ref: '#/definitions/NginxError'
446 delete:
447 tags:
448 - HTTP Caches
449 - Method DELETE
450 summary: |
451 Reset cache statistics
452 description: |
453 Resets statistics of cache hits/misses in a particular cache zone.
454 operationId: deleteHttpCacheZoneStat
455 responses:
456 '204':
457 description: Success
458 '404':
459 description: Cache not found (*CacheNotFound*)
460 schema:
461 $ref: '#/definitions/NginxError'
462 /http/upstreams/:
463 get:
464 tags:
465 - HTTP Upstreams
466 - Method GET
467 summary: |
468 Return status of all HTTP upstream server groups
469 description: |
470 Returns status of each HTTP upstream server group
471 and its servers.
472 operationId: getHttpUpstreams
473 produces:
474 - application/json
475 parameters:
476 - name: fields
477 in: query
478 type: string
479 description: |
480 Limits which fields of upstream server groups will be output.
481 If the “<literal>fields</literal>” value is empty,
482 only names of upstreams are output.
483 responses:
484 '200':
485 description: Success
486 schema:
487 $ref: '#/definitions/NginxHTTPUpstreamMap'
488 '/http/upstreams/{httpUpstreamName}/':
489 parameters:
490 - name: httpUpstreamName
491 in: path
492 description: |
493 The name of an HTTP upstream server group.
494 required: true
495 type: string
496 get:
497 tags:
498 - HTTP Upstreams
499 - Method GET
500 summary: |
501 Return status of an HTTP upstream server group
502 description: |
503 Returns status of a particular HTTP upstream server group
504 and its servers.
505 operationId: getHttpUpstreamName
506 produces:
507 - application/json
508 parameters:
509 - name: fields
510 in: query
511 type: string
512 description: |
513 Limits which fields of the upstream server group will be output.
514 responses:
515 '200':
516 description: Success
517 schema:
518 $ref: '#/definitions/NginxHTTPUpstream'
519 '400':
520 description: |
521 Upstream is static (*UpstreamStatic*)
522 schema:
523 $ref: '#/definitions/NginxError'
524 '404':
525 description: |
526 Upstream not found (*UpstreamNotFound*)
527 schema:
528 $ref: '#/definitions/NginxError'
529 delete:
530 tags:
531 - HTTP Upstreams
532 - Method DELETE
533 summary: |
534 Reset statistics of an HTTP upstream server group
535 description: |
536 Resets the statistics for each upstream server
537 in an upstream server group and queue statistics.
538 operationId: deleteHttpUpstreamStat
539 produces:
540 - application/json
541 responses:
542 '204':
543 description: Success
544 '400':
545 description: |
546 Upstream is static (*UpstreamStatic*)
547 schema:
548 $ref: '#/definitions/NginxError'
549 '404':
550 description: |
551 Upstream not found (*UpstreamNotFound*)
552 schema:
553 $ref: '#/definitions/NginxError'
554 '/http/upstreams/{httpUpstreamName}/servers/':
555 parameters:
556 - name: httpUpstreamName
557 in: path
558 description: |
559 The name of an upstream server group.
560 required: true
561 type: string
562 get:
563 tags:
564 - HTTP Upstreams
565 - Method GET
566 summary: |
567 Return configuration of all servers in an HTTP upstream server group
568 description: |
569 Returns configuration of each server
570 in a particular HTTP upstream server group.
571 operationId: getHttpUpstreamServers
572 produces:
573 - application/json
574 responses:
575 '200':
576 description: Success
577 schema:
578 $ref: '#/definitions/NginxHTTPUpstreamConfServerMap'
579 '400':
580 description: |
581 Upstream is static (*UpstreamStatic*)
582 schema:
583 $ref: '#/definitions/NginxError'
584 '404':
585 description: |
586 Upstream not found (*UpstreamNotFound*)
587 schema:
588 $ref: '#/definitions/NginxError'
589 post:
590 tags:
591 - HTTP Upstreams
592 - Method POST
593 summary: |
594 Add a server to an HTTP upstream server group
595 description: |
596 Adds a new server to an HTTP upstream server group.
597 Server parameters are specified in the JSON format.
598 operationId: postHttpUpstreamServer
599 produces:
600 - application/json
601 parameters:
602 - in: body
603 name: postHttpUpstreamServer
604 description: |
605 Address of a new server and other optional parameters
606 in the JSON format.
607 The “*ID*”, “*backup*”, and “*service*” parameters
608 cannot be changed.
609 required: true
610 schema:
611 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
612 responses:
613 '201':
614 description: Created
615 schema:
616 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
617 '400':
618 description: |
619 Upstream is static (*UpstreamStatic*),
620 invalid “**parameter**” value (*UpstreamConfFormatError*),
621 missing “*server*” argument (*UpstreamConfFormatError*),
622 unknown parameter “**name**” (*UpstreamConfFormatError*),
623 nested object or list (*UpstreamConfFormatError*),
624 “*error*” while parsing (*UpstreamBadAddress*),
625 service upstream “*host*” may not have port (*UpstreamBadAddress*),
626 service upstream “*host*” requires domain name (*UpstreamBadAddress*),
627 invalid “*weight*” (*UpstreamBadWeight*),
628 invalid “*max_conns*” (*UpstreamBadMaxConns*),
629 invalid “*max_fails*” (*UpstreamBadMaxFails*),
630 invalid “*fail_timeout*” (*UpstreamBadFailTimeout*),
631 invalid “*slow_start*” (*UpstreamBadSlowStart*),
632 route is too long (*UpstreamBadRoute*),
633 “*service*” is empty (*UpstreamBadService*),
634 no resolver defined to resolve (*UpstreamConfNoResolver*),
635 upstream “**name**” has no backup (*UpstreamNoBackup*),
636 upstream “**name**” memory exhausted (*UpstreamOutOfMemory*)
637 schema:
638 $ref: '#/definitions/NginxError'
639 '404':
640 description: |
641 Upstream not found (*UpstreamNotFound*)
642 schema:
643 $ref: '#/definitions/NginxError'
644 '415':
645 description: JSON error (*JsonError*)
646 schema:
647 $ref: '#/definitions/NginxError'
648 '/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}':
649 parameters:
650 - name: httpUpstreamName
651 in: path
652 description: |
653 The name of the upstream server group.
654 required: true
655 type: string
656 - name: httpUpstreamServerId
657 in: path
658 description: |
659 The ID of the server.
660 required: true
661 type: string
662 get:
663 tags:
664 - HTTP Upstreams
665 - Method GET
666 summary: |
667 Return configuration of a server in an HTTP upstream server group
668 description: |
669 Returns configuration of a particular server
670 in the HTTP upstream server group.
671 operationId: getHttpUpstreamPeer
672 produces:
673 - application/json
674 responses:
675 '200':
676 description: Success
677 schema:
678 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
679 '400':
680 description: |
681 Upstream is static (*UpstreamStatic*),
682 invalid server ID (*UpstreamBadServerId*)
683 schema:
684 $ref: '#/definitions/NginxError'
685 '404':
686 description: |
687 Upstream not found (*UpstreamNotFound*),
688 server with ID “**id**” does not exist (*UpstreamServerNotFound*)
689 schema:
690 $ref: '#/definitions/NginxError'
691 patch:
692 tags:
693 - HTTP Upstreams
694 - Method PATCH
695 summary: |
696 Modify a server in an HTTP upstream server group
697 description: |
698 Modifies settings of a particular server
699 in an HTTP upstream server group.
700 Server parameters are specified in the JSON format.
701 operationId: patchHttpUpstreamPeer
702 produces:
703 - application/json
704 parameters:
705 - in: body
706 name: patchHttpUpstreamServer
707 description: |
708 Server parameters, specified in the JSON format.
709 The “*ID*”, “*backup*”, and “*service*” parameters
710 cannot be changed.
711 required: true
712 schema:
713 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
714 responses:
715 '200':
716 description: Success
717 schema:
718 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
719 '400':
720 description: |
721 Upstream is static (*UpstreamStatic*),
722 invalid “**parameter**” value (*UpstreamConfFormatError*),
723 unknown parameter “**name**” (*UpstreamConfFormatError*),
724 nested object or list (*UpstreamConfFormatError*),
725 “*error*” while parsing (*UpstreamBadAddress*),
726 invalid “*server*” argument (*UpstreamBadAddress*),
727 invalid server ID (*UpstreamBadServerId*),
728 invalid “*weight*” (*UpstreamBadWeight*),
729 invalid “*max_conns*” (*UpstreamBadMaxConns*),
730 invalid “*max_fails*” (*UpstreamBadMaxFails*),
731 invalid “*fail_timeout*” (*UpstreamBadFailTimeout*),
732 invalid “*slow_start*” (*UpstreamBadSlowStart*),
733 route is too long (*UpstreamBadRoute*),
734 “*service*” is empty (*UpstreamBadService*),
735 server “**ID**” address is immutable (*UpstreamServerImmutable*),
736 server “*ID*” weight is immutable (*UpstreamServerWeightImmutable*),
737 upstream “*name*” memory exhausted (*UpstreamOutOfMemory*)
738 schema:
739 $ref: '#/definitions/NginxError'
740 '404':
741 description: |
742 Upstream not found (*UpstreamNotFound*),
743 server with ID “**id**” does not exist (*UpstreamServerNotFound*)
744 schema:
745 $ref: '#/definitions/NginxError'
746 '415':
747 description: JSON error (*JsonError*)
748 schema:
749 $ref: '#/definitions/NginxError'
750 delete:
751 tags:
752 - HTTP Upstreams
753 - Method DELETE
754 summary: |
755 Remove a server from an HTTP upstream server group
756 description: |
757 Removes a server from an HTTP upstream server group.
758 operationId: deleteHttpUpstreamServer
759 produces:
760 - application/json
761 responses:
762 '200':
763 description: Success
764 schema:
765 $ref: '#/definitions/NginxHTTPUpstreamConfServerMap'
766 '400':
767 description: |
768 Upstream is static (*UpstreamStatic*),
769 invalid server ID (*UpstreamBadServerId*),
770 server “**id**” not removable (*UpstreamServerImmutable*)
771 schema:
772 $ref: '#/definitions/NginxError'
773 '404':
774 description: |
775 Upstream not found (*UpstreamNotFound*),
776 server with ID “**id**” does not exist (*UpstreamServerNotFound*)
777 schema:
778 $ref: '#/definitions/NginxError'
779 /http/keyvals/:
780 get:
781 tags:
782 - HTTP Keyvals
783 - Method GET
784 summary: |
785 Return key-value pairs from all keyval zones
786 description: |
787 Returns key-value pairs for each keyval shared memory
788 [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
789 operationId: getHttpKeyvalZones
790 produces:
791 - application/json
792 parameters:
793 - name: fields
794 in: query
795 type: string
796 description: |
797 If the “<literal>fields</literal>” value is empty,
798 then only keyval zone names are output.
799 responses:
800 '200':
801 description: Success
802 schema:
803 $ref: '#/definitions/NginxHTTPKeyvalZonesMap'
804 '/http/keyvals/{httpKeyvalZoneName}':
805 parameters:
806 - name: httpKeyvalZoneName
807 in: path
808 description: |
809 The name of a keyval shared memory zone.
810 required: true
811 type: string
812 get:
813 tags:
814 - HTTP Keyvals
815 - Method GET
816 summary: |
817 Return key-value pairs from a keyval zone
818 description: |
819 Returns key-value pairs stored in a particular keyval shared memory
820 [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
821 operationId: getHttpKeyvalZoneKeysValues
822 produces:
823 - application/json
824 parameters:
825 - name: key
826 in: query
827 type: string
828 description: |
829 Get a particular key-value pair from the keyval zone.
830 responses:
831 '200':
832 description: Success
833 schema:
834 $ref: '#/definitions/NginxHTTPKeyvalZone'
835 '404':
836 description: |
837 Keyval not found (*KeyvalNotFound*),
838 keyval key not found (*KeyvalKeyNotFound*)
839 schema:
840 $ref: '#/definitions/NginxError'
841 post:
842 tags:
843 - HTTP Keyvals
844 - Method POST
845 summary: |
846 Add a key-value pair to the keyval zone
847 description: |
848 Adds a new key-value pair to the keyval shared memory
849 [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
850 Several key-value pairs can be entered
851 if the keyval shared memory zone is empty.
852 operationId: postHttpKeyvalZoneData
853 produces:
854 - application/json
855 parameters:
856 - in: body
857 name: Key-value
858 description: |
859 A key-value pair is specified in the JSON format.
860 Several key-value pairs can be entered
861 if the keyval shared memory zone is empty.
862 required: true
863 schema:
864 $ref: '#/definitions/NginxHTTPKeyvalZone'
865 responses:
866 '201':
867 description: Created
868 '400':
869 description: |
870 Key required (*KeyvalFormatError*),
871 only one key can be added (*KeyvalFormatError*),
872 nested object or list (*KeyvalFormatError*)
873 schema:
874 $ref: '#/definitions/NginxError'
875 '404':
876 description: Keyval not found (*KeyvalNotFound*)
877 schema:
878 $ref: '#/definitions/NginxError'
879 '409':
880 description: Key already exists (*KeyvalKeyExists*)
881 schema:
882 $ref: '#/definitions/NginxError'
883 '415':
884 description: JSON error (*JsonError*)
885 schema:
886 $ref: '#/definitions/NginxError'
887 patch:
888 tags:
889 - HTTP Keyvals
890 - Method PATCH
891 summary: |
892 Modify a key-value or delete a key
893 description: |
894 Changes the value of the selected key in the key-value pair
895 or deletes a key by setting the key value to <literal>null</literal>.
896 operationId: patchHttpKeyvalZoneKeyValue
897 produces:
898 - application/json
899 parameters:
900 - in: body
901 name: httpKeyvalZoneKeyValue
902 description: |
903 A new value for the key is specified in the JSON format.
904 required: true
905 schema:
906 $ref: '#/definitions/NginxHTTPKeyvalZone'
907 responses:
908 '204':
909 description: Success
910 '400':
911 description: |
912 Key required (*KeyvalFormatError*),
913 only one key can be updated (*KeyvalFormatError*),
914 nested object or list (*KeyvalFormatError*)
915 schema:
916 $ref: '#/definitions/NginxError'
917 '404':
918 description: |
919 Keyval not found (*KeyvalNotFound*),
920 keyval key not found (*KeyvalKeyNotFound*)
921 schema:
922 $ref: '#/definitions/NginxError'
923 '415':
924 description: JSON error (*JsonError*)
925 schema:
926 $ref: '#/definitions/NginxError'
927 delete:
928 tags:
929 - HTTP Keyvals
930 - Method DELETE
931 summary: |
932 Empty the keyval zone
933 description: |
934 Deletes all key-value pairs from the keyval shared memory
935 [zone](https://nginx.org/en/docs/http/ngx_http_keyval_module.html#keyval_zone).
936 operationId: deleteHttpKeyvalZoneData
937 responses:
938 '204':
939 description: Success
940 '404':
941 description: Keyval not found (*KeyvalNotFound*)
942 schema:
943 $ref: '#/definitions/NginxError'
944 /stream/:
945 get:
946 tags:
947 - Stream
948 summary: |
949 Return list of stream-related endpoints
950 description: |
951 Returns a list of first level stream endpoints.
952 operationId: getStream
953 produces:
954 - application/json
955 responses:
956 '200':
957 description: Success
958 schema:
959 $ref: '#/definitions/ArrayOfStrings'
960 /stream/server_zones/:
961 get:
962 tags:
963 - Stream Server Zones
964 - Method GET
965 summary: |
966 Return status of all stream server zones
967 description: |
968 Returns status information for each stream
969 [server zone](https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone).
970 operationId: getStreamServerZones
971 produces:
972 - application/json
973 parameters:
974 - name: fields
975 in: query
976 type: string
977 description: |
978 Limits which fields of server zones will be output.
979 If the “<literal>fields</literal>” value is empty,
980 then only server zone names are output.
981 responses:
982 '200':
983 description: Success
984 schema:
985 $ref: '#/definitions/NginxStreamServerZonesMap'
986 '404':
987 description: |
988 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
989 not configured (*StreamNotConfigured*)
990 schema:
991 $ref: '#/definitions/NginxError'
992 '/stream/server_zones/{streamServerZoneName}':
993 parameters:
994 - name: streamServerZoneName
995 in: path
996 description: |
997 The name of a stream server zone.
998 type: string
999 required: true
1000 get:
1001 tags:
1002 - Stream Server Zones
1003 - Method GET
1004 summary: |
1005 Return status of a stream server zone
1006 description: |
1007 Returns status of a particular stream server zone.
1008 operationId: getStreamServerZone
1009 produces:
1010 - application/json
1011 parameters:
1012 - name: fields
1013 in: query
1014 type: string
1015 description: |
1016 Limits which fields of the server zone will be output.
1017 responses:
1018 '200':
1019 description: Success
1020 schema:
1021 $ref: '#/definitions/NginxStreamServerZone'
1022 '404':
1023 description: |
1024 Server zone not found (*ServerZoneNotFound*),
1025 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1026 not configured (*StreamNotConfigured*)
1027 schema:
1028 $ref: '#/definitions/NginxError'
1029 delete:
1030 tags:
1031 - Stream Server Zones
1032 - Method DELETE
1033 summary: |
1034 Reset statistics for a stream server zone
1035 description: |
1036 Resets statistics of accepted and discarded connections, sessions,
1037 received and sent bytes in a particular stream server zone.
1038 operationId: deleteStreamServerZoneStat
1039 responses:
1040 '204':
1041 description: Success
1042 '404':
1043 description: |
1044 Server zone not found (*ServerZoneNotFound*),
1045 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1046 not configured (*StreamNotConfigured*)
1047 schema:
1048 $ref: '#/definitions/NginxError'
1049 /stream/upstreams/:
1050 get:
1051 tags:
1052 - Stream Upstreams
1053 - Method GET
1054 summary: |
1055 Return status of all stream upstream server groups
1056 description: |
1057 Returns status of each stream upstream server group
1058 and its servers.
1059 operationId: getStreamUpstreams
1060 produces:
1061 - application/json
1062 parameters:
1063 - name: fields
1064 in: query
1065 type: string
1066 description: |
1067 Limits which fields of upstream server groups will be output.
1068 If the “<literal>fields</literal>” value is empty,
1069 only names of upstreams are output.
1070 responses:
1071 '200':
1072 description: Success
1073 schema:
1074 $ref: '#/definitions/NginxStreamUpstreamMap'
1075 '404':
1076 description: |
1077 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1078 not configured (*StreamNotConfigured*)
1079 schema:
1080 $ref: '#/definitions/NginxError'
1081 '/stream/upstreams/{streamUpstreamName}/':
1082 parameters:
1083 - name: streamUpstreamName
1084 in: path
1085 description: |
1086 The name of a stream upstream server group.
1087 required: true
1088 type: string
1089 get:
1090 tags:
1091 - Stream Upstreams
1092 - Method GET
1093 summary: |
1094 Return status of a stream upstream server group
1095 description: |
1096 Returns status of a particular stream upstream server group
1097 and its servers.
1098 operationId: getStreamUpstream
1099 produces:
1100 - application/json
1101 parameters:
1102 - name: fields
1103 in: query
1104 type: string
1105 description: |
1106 Limits which fields of the upstream server group will be output.
1107 responses:
1108 '200':
1109 description: Success
1110 schema:
1111 $ref: '#/definitions/NginxStreamUpstream'
1112 '400':
1113 description: |
1114 Upstream is static (*UpstreamStatic*)
1115 schema:
1116 $ref: '#/definitions/NginxError'
1117 '404':
1118 description: |
1119 Upstream not found (*UpstreamNotFound*),
1120 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1121 not configured (*StreamNotConfigured*)
1122 schema:
1123 $ref: '#/definitions/NginxError'
1124 delete:
1125 tags:
1126 - Stream Upstreams
1127 - Method DELETE
1128 summary: |
1129 Reset statistics of a stream upstream server group
1130 description: |
1131 Resets the statistics for each upstream server
1132 in an upstream server group.
1133 operationId: deleteStreamUpstreamStat
1134 produces:
1135 - application/json
1136 responses:
1137 '204':
1138 description: Success
1139 '400':
1140 description: |
1141 Upstream is static (*UpstreamStatic*)
1142 schema:
1143 $ref: '#/definitions/NginxError'
1144 '404':
1145 description: |
1146 Upstream not found (*UpstreamNotFound*),
1147 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1148 not configured (*StreamNotConfigured*)
1149 schema:
1150 $ref: '#/definitions/NginxError'
1151 '/stream/upstreams/{streamUpstreamName}/servers/':
1152 parameters:
1153 - name: streamUpstreamName
1154 in: path
1155 description: |
1156 The name of an upstream server group.
1157 required: true
1158 type: string
1159 get:
1160 tags:
1161 - Stream Upstreams
1162 - Method GET
1163 summary: |
1164 Return configuration of all servers in a stream upstream server group
1165 description: |
1166 Returns configuration of each server
1167 in a particular stream upstream server group.
1168 operationId: getStreamUpstreamServers
1169 produces:
1170 - application/json
1171 responses:
1172 '200':
1173 description: Success
1174 schema:
1175 $ref: '#/definitions/NginxStreamUpstreamConfServerMap'
1176 '400':
1177 description: |
1178 Upstream is static (*UpstreamStatic*)
1179 schema:
1180 $ref: '#/definitions/NginxError'
1181 '404':
1182 description: |
1183 Upstream not found (*UpstreamNotFound*),
1184 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1185 not configured (*StreamNotConfigured*)
1186 schema:
1187 $ref: '#/definitions/NginxError'
1188 post:
1189 tags:
1190 - Stream Upstreams
1191 - Method POST
1192 summary: |
1193 Add a server to a stream upstream server group
1194 description: |
1195 Adds a new server to a stream upstream server group.
1196 Server parameters are specified in the JSON format.
1197 operationId: postStreamUpstreamServer
1198 produces:
1199 - application/json
1200 parameters:
1201 - in: body
1202 name: postStreamUpstreamServer
1203 description: |
1204 Address of a new server and other optional parameters
1205 in the JSON format.
1206 The “*ID*”, “*backup*”, and “*service*” parameters
1207 cannot be changed.
1208 required: true
1209 schema:
1210 $ref: '#/definitions/NginxStreamUpstreamConfServer'
1211 responses:
1212 '201':
1213 description: Created
1214 schema:
1215 $ref: '#/definitions/NginxStreamUpstreamConfServer'
1216 '400':
1217 description: |
1218 Upstream is static (*UpstreamStatic*),
1219 invalid “**parameter**” value (*UpstreamConfFormatError*),
1220 missing “*server*” argument (*UpstreamConfFormatError*),
1221 unknown parameter “**name**” (*UpstreamConfFormatError*),
1222 nested object or list (*UpstreamConfFormatError*),
1223 “*error*” while parsing (*UpstreamBadAddress*),
1224 no port in server “*host*” (*UpstreamBadAddress*),
1225 service upstream “*host*” may not have port (*UpstreamBadAddress*),
1226 service upstream “*host*” requires domain name (*UpstreamBadAddress*),
1227 invalid “*weight*” (*UpstreamBadWeight*),
1228 invalid “*max_conns*” (*UpstreamBadMaxConns*),
1229 invalid “*max_fails*” (*UpstreamBadMaxFails*),
1230 invalid “*fail_timeout*” (*UpstreamBadFailTimeout*),
1231 invalid “*slow_start*” (*UpstreamBadSlowStart*),
1232 “*service*” is empty (*UpstreamBadService*),
1233 no resolver defined to resolve (*UpstreamConfNoResolver*),
1234 upstream “**name**” has no backup (*UpstreamNoBackup*),
1235 upstream “**name**” memory exhausted (*UpstreamOutOfMemory*)
1236 schema:
1237 $ref: '#/definitions/NginxError'
1238 '404':
1239 description: |
1240 Upstream not found (*UpstreamNotFound*),
1241 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1242 not configured (*StreamNotConfigured*)
1243 schema:
1244 $ref: '#/definitions/NginxError'
1245 '415':
1246 description: JSON error (*JsonError*)
1247 schema:
1248 $ref: '#/definitions/NginxError'
1249 '/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}':
1250 parameters:
1251 - name: streamUpstreamName
1252 in: path
1253 description: |
1254 The name of the upstream server group.
1255 required: true
1256 type: string
1257 - name: streamUpstreamServerId
1258 in: path
1259 description: |
1260 The ID of the server.
1261 required: true
1262 type: string
1263 get:
1264 tags:
1265 - Stream Upstreams
1266 - Method GET
1267 summary: |
1268 Return configuration of a server in a stream upstream server group
1269 description: |
1270 Returns configuration of a particular server
1271 in the stream upstream server group.
1272 operationId: getStreamUpstreamServer
1273 produces:
1274 - application/json
1275 responses:
1276 '200':
1277 description: Success
1278 schema:
1279 $ref: '#/definitions/NginxStreamUpstreamConfServer'
1280 '400':
1281 description: |
1282 Upstream is static (*UpstreamStatic*),
1283 invalid server ID (*UpstreamBadServerId*)
1284 schema:
1285 $ref: '#/definitions/NginxError'
1286 '404':
1287 description: |
1288 Upstream not found (*UpstreamNotFound*),
1289 server with ID “**id**” does not exist (*UpstreamServerNotFound*),
1290 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1291 not configured (*StreamNotConfigured*)
1292 schema:
1293 $ref: '#/definitions/NginxError'
1294 patch:
1295 tags:
1296 - Stream Upstreams
1297 - Method PATCH
1298 summary: |
1299 Modify a server in a stream upstream server group
1300 description: |
1301 Modifies settings of a particular server
1302 in a stream upstream server group.
1303 Server parameters are specified in the JSON format.
1304 operationId: patchStreamUpstreamServer
1305 produces:
1306 - application/json
1307 parameters:
1308 - in: body
1309 name: patchStreamUpstreamServer
1310 description: |
1311 Server parameters, specified in the JSON format.
1312 The “*ID*”, “*backup*”, and “*service*” parameters
1313 cannot be changed.
1314 required: true
1315 schema:
1316 $ref: '#/definitions/NginxStreamUpstreamConfServer'
1317 responses:
1318 '200':
1319 description: Success
1320 schema:
1321 $ref: '#/definitions/NginxStreamUpstreamConfServer'
1322 '400':
1323 description: |
1324 Upstream is static (*UpstreamStatic*),
1325 invalid “**parameter**” value (*UpstreamConfFormatError*),
1326 unknown parameter “**name**” (*UpstreamConfFormatError*),
1327 nested object or list (*UpstreamConfFormatError*),
1328 “*error*” while parsing (*UpstreamBadAddress*),
1329 invalid “*server*” argument (*UpstreamBadAddress*),
1330 no port in server “*host*” (*UpstreamBadAddress*),
1331 invalid server ID (*UpstreamBadServerId*),
1332 invalid “*weight*” (*UpstreamBadWeight*),
1333 invalid “*max_conns*” (*UpstreamBadMaxConns*),
1334 invalid “*max_fails*” (*UpstreamBadMaxFails*),
1335 invalid “*fail_timeout*” (*UpstreamBadFailTimeout*),
1336 invalid “*slow_start*” (*UpstreamBadSlowStart*),
1337 “*service*” is empty (*UpstreamBadService*),
1338 server “**ID**” address is immutable (*UpstreamServerImmutable*),
1339 server “**ID**” weight is immutable (*UpstreamServerWeightImmutable*),
1340 upstream “*name*” memory exhausted (*UpstreamOutOfMemory*)
1341 schema:
1342 $ref: '#/definitions/NginxError'
1343 '404':
1344 description: |
1345 Upstream not found (*UpstreamNotFound*),
1346 server with ID “**id**” does not exist (*UpstreamServerNotFound*),
1347 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1348 not configured (*StreamNotConfigured*)
1349 schema:
1350 $ref: '#/definitions/NginxError'
1351 '415':
1352 description: JSON error (*JsonError*)
1353 schema:
1354 $ref: '#/definitions/NginxError'
1355 delete:
1356 tags:
1357 - Stream Upstreams
1358 - Method DELETE
1359 summary: |
1360 Remove a server from a stream upstream server group
1361 description: |
1362 Removes a server from a stream server group.
1363 operationId: deleteStreamUpstreamServer
1364 produces:
1365 - application/json
1366 responses:
1367 '200':
1368 description: Success
1369 schema:
1370 $ref: '#/definitions/NginxStreamUpstreamConfServerMap'
1371 '400':
1372 description: |
1373 Upstream is static (*UpstreamStatic*),
1374 invalid server ID (*UpstreamBadServerId*),
1375 server “**id**” not removable (*UpstreamServerImmutable*)
1376 schema:
1377 $ref: '#/definitions/NginxError'
1378 '404':
1379 description: |
1380 Upstream not found (*UpstreamNotFound*),
1381 server with ID “**id**” does not exist (*UpstreamServerNotFound*),
1382 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream)
1383 not configured (*StreamNotConfigured*)
1384 schema:
1385 $ref: '#/definitions/NginxError'
1386 ###
1387 ###DEFINITIONS
1388 ###
1389 definitions:
1390 ArrayOfStrings:
1391 title: Array
1392 description: |
1393 An array of strings.
1394 type: array
1395 items:
1396 type: string
1397 NginxObject:
1398 title: nginx
1399 description: |
1400 General information about nginx:
1401 type: object
1402 properties:
1403 version:
1404 type: string
1405 description: |
1406 Version of nginx.
1407 build:
1408 type: string
1409 description: |
1410 Name of nginx build.
1411 address:
1412 type: string
1413 description: The address of the server that accepted status request.
1414 generation:
1415 type: integer
1416 description: |
1417 The total number of configuration
1418 <a href="https://nginx.org/en/docs/control.html#reconfiguration">reloads</a>.
1419 load_timestamp:
1420 type: string
1421 format: date-time
1422 description: |
1423 Time of the last reload of configuration,
1424 in milliseconds since Epoch.
1425 timestamp:
1426 type: string
1427 format: date-time
1428 description: |
1429 Current time in milliseconds since Epoch.
1430 pid:
1431 type: integer
1432 description: |
1433 The ID of the worker process that handled status request.
1434 ppid:
1435 type: integer
1436 description: |
1437 The ID of the master process that started the
1438 <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</a>.
1439 example:
1440 nginx:
1441 version: 1.13.3
1442 build: nginx-plus-r12-p3
1443 address: 206.251.255.64
1444 generation: 2
1445 load_timestamp: 2017-07-07T11:09:21.594Z
1446 timestamp: 2017-07-11T09:31:13.477Z
1447 pid: 32212
1448 ppid: 32210
1449 NginxProcesses:
1450 title: Processes
1451 type: object
1452 properties:
1453 respawned:
1454 type: integer
1455 description: |
1456 The total number of abnormally terminated
1457 and respawned child processes.
1458 example:
1459 respawned: 0
1460 NginxConnections:
1461 title: Connections
1462 description: |
1463 The number of accepted, dropped, active, and idle connections.
1464 type: object
1465 properties:
1466 accepted:
1467 type: integer
1468 description: |
1469 The total number of accepted client connections.
1470 dropped:
1471 type: integer
1472 description: |
1473 The total number of dropped client connections.
1474 active:
1475 type: integer
1476 description: |
1477 The current number of active client connections.
1478 idle:
1479 type: integer
1480 description: |
1481 The current number of idle client connections.
1482 example:
1483 accepted: 4968119
1484 dropped: 0
1485 active: 5
1486 idle: 117
1487 NginxSSLObject:
1488 title: SSL
1489 type: object
1490 properties:
1491 handshakes:
1492 type: integer
1493 description: |
1494 The total number of successful SSL handshakes.
1495 handshakes_failed:
1496 type: integer
1497 description: |
1498 The total number of failed SSL handshakes.
1499 session_reuses:
1500 type: integer
1501 description: |
1502 The total number of session reuses during SSL handshake.
1503 example:
1504 handshakes: 79572
1505 handshakes_failed: 21025
1506 session_reuses: 15762
1507 NginxSlabZoneMap:
1508 title: Slab Zones
1509 description: |
1510 Status zones that use slab allocator.
1511 type: object
1512 additionalProperties:
1513 $ref: '#/definitions/NginxSlabZone'
1514 example:
1515 http_cache:
1516 pages:
1517 used: 2
1518 free: 2452
1519 slots:
1520 8:
1521 used: 0
1522 free: 0
1523 reqs: 0
1524 fails: 0
1525 16:
1526 used: 0
1527 free: 0
1528 reqs: 0
1529 fails: 0
1530 32:
1531 used: 1
1532 free: 126
1533 reqs: 1
1534 fails: 0
1535 64:
1536 used: 2
1537 free: 62
1538 reqs: 2
1539 fails: 0
1540 128:
1541 used: 0
1542 free: 0
1543 reqs: 0
1544 fails: 0
1545 dns-backends:
1546 pages:
1547 used: 1143
1548 free: 2928
1549 slots:
1550 8:
1551 used: 0
1552 free: 0
1553 reqs: 0
1554 fails: 0
1555 16:
1556 used: 0
1557 free: 0
1558 reqs: 0
1559 fails: 0
1560 32:
1561 used: 0
1562 free: 0
1563 reqs: 0
1564 fails: 0
1565 64:
1566 used: 1
1567 free: 63
1568 reqs: 1
1569 fails: 0
1570 128:
1571 used: 0
1572 free: 0
1573 reqs: 0
1574 fails: 0
1575 256:
1576 used: 18078
1577 free: 178
1578 reqs: 1635736
1579 fails: 0
1580 NginxSlabZone:
1581 title: Shared memory zone with slab allocator
1582 description: |
1583 type: object
1584 properties:
1585 pages:
1586 type: object
1587 description: |
1588 The number of free and used memory pages.
1589 properties:
1590 used:
1591 type: integer
1592 description: |
1593 The current number of used memory pages.
1594 free:
1595 type: integer
1596 description: |
1597 The current number of free memory pages.
1598 slots:
1599 type: object
1600 title: Memory Slots
1601 description: |
1602 Status data for memory slots (8, 16, 32, 64, 128, etc.)
1603 additionalProperties:
1604 $ref: '#/definitions/NginxSlabZoneSlot'
1605 example:
1606 pages:
1607 used: 1143
1608 free: 2928
1609 slots:
1610 8:
1611 used: 0
1612 free: 0
1613 reqs: 0
1614 fails: 0
1615 16:
1616 used: 0
1617 free: 0
1618 reqs: 0
1619 fails: 0
1620 32:
1621 used: 0
1622 free: 0
1623 reqs: 0
1624 fails: 0
1625 64:
1626 used: 1
1627 free: 63
1628 reqs: 1
1629 fails: 0
1630 128:
1631 used: 0
1632 free: 0
1633 reqs: 0
1634 fails: 0
1635 256:
1636 used: 18078
1637 free: 178
1638 reqs: 1635736
1639 fails: 0
1640 NginxSlabZoneSlot:
1641 title: Memory Slot
1642 type: object
1643 properties:
1644 used:
1645 type: integer
1646 description: |
1647 The current number of used memory slots.
1648 free:
1649 type: integer
1650 description: |
1651 The current number of free memory slots.
1652 reqs:
1653 type: integer
1654 description: |
1655 The total number of attempts
1656 to allocate memory of specified size.
1657 fails:
1658 type: integer
1659 description: |
1660 The number of unsuccessful attempts
1661 to allocate memory of specified size.
1662 NginxHTTPRequests:
1663 title: HTTP Requests
1664 type: object
1665 properties:
1666 total:
1667 type: integer
1668 description: |
1669 The total number of client requests.
1670 current:
1671 type: integer
1672 description: |
1673 The current number of client requests.
1674 example:
1675 total: 10624511
1676 current: 4
1677 NginxHTTPServerZonesMap:
1678 title: HTTP Server Zones
1679 description: |
1680 Status data for all HTTP
1681 <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone">status zones</a>.
1682 type: object
1683 additionalProperties:
1684 $ref: '#/definitions/NginxHTTPServerZone'
1685 example:
1686 site1:
1687 processing: 2
1688 requests: 736395
1689 responses:
1690 1xx: 0
1691 2xx: 727290
1692 3xx: 4614
1693 4xx: 934
1694 5xx: 1535
1695 total: 734373
1696 discarded: 2020
1697 received: 180157219
1698 sent: 20183175459
1699 site2:
1700 processing: 1
1701 requests: 185307
1702 responses:
1703 1xx: 0
1704 2xx: 112674
1705 3xx: 45383
1706 4xx: 2504
1707 5xx: 4419
1708 total: 164980
1709 discarded: 20326
1710 received: 51575327
1711 sent: 2983241510
1712 NginxHTTPServerZone:
1713 title: HTTP Server Zone
1714 type: object
1715 properties:
1716 processing:
1717 type: integer
1718 description: |
1719 The number of client requests
1720 that are currently being processed.
1721 requests:
1722 type: integer
1723 description: |
1724 The total number of client requests received from clients.
1725 responses:
1726 description: |
1727 The total number of responses sent to clients and the
1728 number of responses with status codes
1729 “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”,
1730 “<code>4xx</code>”, and “<code>5xx</code>”.
1731 type: object
1732 readOnly: true
1733 properties:
1734 1xx:
1735 type: integer
1736 description: |
1737 The number of responses with “<code>1xx</code>” status codes.
1738 readOnly: true
1739 2xx:
1740 type: integer
1741 description: |
1742 The number of responses with “<code>2xx</code>” status codes.
1743 readOnly: true
1744 3xx:
1745 type: integer
1746 description: |
1747 The number of responses with “<code>3xx</code>” status codes.
1748 readOnly: true
1749 4xx:
1750 type: integer
1751 description: |
1752 The number of responses with “<code>4xx</code>” status codes.
1753 readOnly: true
1754 5xx:
1755 type: integer
1756 description: |
1757 The number of responses with “<code>5xx</code>” status codes.
1758 readOnly: true
1759 total:
1760 type: integer
1761 description: The total number of responses sent to clients.
1762 readOnly: true
1763 discarded:
1764 type: integer
1765 description: |
1766 The total number of
1767 requests completed without sending a response.
1768 received:
1769 type: integer
1770 description: |
1771 The total number of bytes received from clients.
1772 sent:
1773 type: integer
1774 description: |
1775 The total number of bytes sent to clients.
1776 example:
1777 processing: 1
1778 requests: 706690
1779 responses:
1780 1xx: 0
1781 2xx: 699482
1782 3xx: 4522
1783 4xx: 907
1784 5xx: 266
1785 total: 705177
1786 discarded: 1513
1787 received: 172711587
1788 sent: 19415530115
1789 NginxHTTPCachesMap:
1790 title: HTTP Caches
1791 description: |
1792 Status information of all HTTP caches configured by
1793 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_path">proxy_cache_path</a>
1794 and other “<code>*_cache_path</code>” directives.
1795 type: object
1796 additionalProperties:
1797 $ref: '#/definitions/NginxHTTPCache'
1798 example:
1799 http-cache:
1800 size: 530915328
1801 max_size: 536870912
1802 cold: false
1803 hit:
1804 responses: 254032
1805 bytes: 6685627875
1806 stale:
1807 responses: 0
1808 bytes: 0
1809 updating:
1810 responses: 0
1811 bytes: 0
1812 revalidated:
1813 responses: 0
1814 bytes: 0
1815 miss:
1816 responses: 1619201
1817 bytes: 53841943822
1818 expired:
1819 responses: 45859
1820 bytes: 1656847080
1821 responses_written: 44992
1822 bytes_written: 1641825173
1823 bypass:
1824 responses: 200187
1825 bytes: 5510647548
1826 responses_written: 200173
1827 bytes_written: 44992
1828 frontend-cache:
1829 size: 530915328
1830 max_size: 536870912
1831 cold: false
1832 hit:
1833 responses: 254032
1834 bytes: 6685627875
1835 stale:
1836 responses: 0
1837 bytes: 0
1838 updating:
1839 responses: 0
1840 bytes: 0
1841 revalidated:
1842 responses: 0
1843 bytes: 0
1844 miss:
1845 responses: 1619201
1846 bytes: 53841943822
1847 expired:
1848 responses: 45859
1849 bytes: 1656847080
1850 responses_written: 44992
1851 bytes_written: 1641825173
1852 bypass:
1853 responses: 200187
1854 bytes: 5510647548
1855 responses_written: 200173
1856 bytes_written: 44992
1857 NginxHTTPCache:
1858 title: HTTP Cache
1859 type: object
1860 properties:
1861 size:
1862 type: integer
1863 description: |
1864 The current size of the cache.
1865 max_size:
1866 type: integer
1867 description: |
1868 The limit on the maximum size of the cache
1869 specified in the configuration.
1870 cold:
1871 type: boolean
1872 description: |
1873 A boolean value indicating whether the “cache loader” process
1874 is still loading data from disk into the cache.
1875 hit:
1876 type: object
1877 properties:
1878 responses:
1879 type: integer
1880 description: |
1881 The total number of
1882 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_valid">valid</a>
1883 responses read from the cache.
1884 bytes:
1885 type: integer
1886 description: |
1887 The total number of bytes read from the cache.
1888 stale:
1889 type: object
1890 properties:
1891 responses:
1892 type: integer
1893 description: |
1894 The total number of expired responses read from the cache (see
1895 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale">proxy_cache_use_stale</a>
1896 and other “<code>*_cache_use_stale</code>” directives).
1897 bytes:
1898 type: integer
1899 description: The total number of bytes read from the cache.
1900 updating:
1901 type: object
1902 properties:
1903 responses:
1904 type: integer
1905 description: |
1906 The total number of expired responses read from the cache
1907 while responses were being updated (see
1908 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_use_stale_updating">proxy_cache_use_stale</a>
1909 and other “<code>*_cache_use_stale</code>” directives).
1910 bytes:
1911 type: integer
1912 description: |
1913 The total number of bytes read from the cache.
1914 revalidated:
1915 type: object
1916 properties:
1917 responses:
1918 type: integer
1919 description: |
1920 The total number of expired and revalidated responses
1921 read from the cache (see
1922 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_revalidate">proxy_cache_revalidate</a>
1923 and other “<code>*_cache_revalidate</code>” directives.
1924 bytes:
1925 type: integer
1926 description: |
1927 The total number of bytes read from the cache.
1928 miss:
1929 type: object
1930 properties:
1931 responses:
1932 type: integer
1933 description: |
1934 The total number of responses not found in the cache.
1935 bytes:
1936 type: integer
1937 description: |
1938 The total number of bytes read from the proxied server.
1939 responses_written:
1940 type: integer
1941 description: |
1942 The total number of responses written to the cache.
1943 bytes_written:
1944 type: integer
1945 description: |
1946 The total number of bytes written to the cache.
1947 expired:
1948 type: object
1949 properties:
1950 responses:
1951 type: integer
1952 description: |
1953 The total number of expired responses not taken from the cache.
1954 bytes:
1955 type: integer
1956 description: |
1957 The total number of bytes read from the proxied server.
1958 responses_written:
1959 type: integer
1960 description: |
1961 The total number of responses written to the cache.
1962 bytes_written:
1963 type: integer
1964 description: |
1965 The total number of bytes written to the cache.
1966 bypass:
1967 type: object
1968 properties:
1969 responses:
1970 type: integer
1971 description: |
1972 The total number of responses not looked up in the cache due to the
1973 <a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cache_bypass">proxy_cache_bypass</a>
1974 and other “<code>*_cache_bypass</code>” directives.
1975 bytes:
1976 type: integer
1977 description: |
1978 The total number of bytes read from the proxied server.
1979 responses_written:
1980 type: integer
1981 description: |
1982 The total number of responses written to the cache.
1983 bytes_written:
1984 type: integer
1985 description: |
1986 The total number of bytes written to the cache.
1987 example:
1988 size: 530915328
1989 max_size: 536870912
1990 cold: false
1991 hit:
1992 responses: 254032
1993 bytes: 6685627875
1994 stale:
1995 responses: 0
1996 bytes: 0
1997 updating:
1998 responses: 0
1999 bytes: 0
2000 revalidated:
2001 responses: 0
2002 bytes: 0
2003 miss:
2004 responses: 1619201
2005 bytes: 53841943822
2006 expired:
2007 responses: 45859
2008 bytes: 1656847080
2009 responses_written: 44992
2010 bytes_written: 1641825173
2011 bypass:
2012 responses: 200187
2013 bytes: 5510647548
2014 responses_written: 200173
2015 bytes_written: 44992
2016 NginxHTTPUpstreamMap:
2017 title: HTTP Upstreams
2018 description: |
2019 Status information of all HTTP
2020 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">dynamically configurable</a>
2021 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream">groups</a>.
2022 type: object
2023 additionalProperties:
2024 $ref: '#/definitions/NginxHTTPUpstream'
2025 example:
2026 trac-backend:
2027 peers:
2028 - id: 0
2029 server: 10.0.0.1:8088
2030 name: 10.0.0.1:8088
2031 backup: false
2032 weight: 5
2033 state: up
2034 active: 0
2035 requests: 667231
2036 header_time: 20
2037 response_time: 36
2038 responses:
2039 1xx: 0
2040 2xx: 666310
2041 3xx: 0
2042 4xx: 915
2043 5xx: 6
2044 total: 667231
2045 sent: 251946292
2046 received: 19222475454
2047 fails: 0
2048 unavail: 0
2049 health_checks:
2050 checks: 26214
2051 fails: 0
2052 unhealthy: 0
2053 last_passed: true
2054 downtime: 0
2055 downstart: 2017-07-07T11:09:21.602Z
2056 selected: 2017-07-17T15:01:25Z
2057 - id: 1
2058 server: 10.0.0.1:8089
2059 name: 10.0.0.1:8089
2060 backup: true
2061 weight: 1
2062 state: unhealthy
2063 active: 0
2064 requests: 0
2065 responses:
2066 1xx: 0
2067 2xx: 0
2068 3xx: 0
2069 4xx: 0
2070 5xx: 0
2071 total: 0
2072 sent: 0
2073 received: 0
2074 fails: 0
2075 unavail: 0
2076 health_checks:
2077 checks: 26284
2078 fails: 26284
2079 unhealthy: 1
2080 last_passed: false
2081 downtime: 262925617
2082 downstart: 2017-07-07T11:09:21.602Z
2083 selected: 2017-07-17T15:01:25Z
2084 keepalive: 0
2085 zombies: 0
2086 zone: trac-backend
2087 hg-backend:
2088 peers:
2089 - id: 0
2090 server: 10.0.0.1:8088
2091 name: 10.0.0.1:8088
2092 backup: false
2093 weight: 5
2094 state: up
2095 active: 0
2096 requests: 667231
2097 header_time: 20
2098 response_time: 36
2099 responses:
2100 1xx: 0
2101 2xx: 666310
2102 3xx: 0
2103 4xx: 915
2104 5xx: 6
2105 total: 667231
2106 sent: 251946292
2107 received: 19222475454
2108 fails: 0
2109 unavail: 0
2110 health_checks:
2111 checks: 26214
2112 fails: 0
2113 unhealthy: 0
2114 last_passed: true
2115 downtime: 0
2116 downstart: 2017-07-07T11:09:21.602Z
2117 selected: 2017-07-17T15:01:25Z
2118 - id: 1
2119 server: 10.0.0.1:8089
2120 name: 10.0.0.1:8089
2121 backup: true
2122 weight: 1
2123 state: unhealthy
2124 active: 0
2125 requests: 0
2126 responses:
2127 1xx: 0
2128 2xx: 0
2129 3xx: 0
2130 4xx: 0
2131 5xx: 0
2132 total: 0
2133 sent: 0
2134 received: 0
2135 fails: 0
2136 unavail: 0
2137 health_checks:
2138 checks: 26284
2139 fails: 26284
2140 unhealthy: 1
2141 last_passed: false
2142 downtime: 262925617
2143 downstart: 2017-07-07T11:09:21.602Z
2144 selected: 2017-07-17T15:01:25Z
2145 keepalive: 0
2146 zombies: 0
2147 zone: hg-backend
2148 NginxHTTPUpstream:
2149 title: HTTP Upstream
2150 type: object
2151 properties:
2152 peers:
2153 $ref: '#/definitions/NginxHTTPUpstreamPeerMap'
2154 keepalive:
2155 type: integer
2156 description: |
2157 The current number of idle
2158 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive">keepalive</a>
2159 connections.
2160 zombies:
2161 type: integer
2162 description: |
2163 The current number of servers removed
2164 from the group but still processing active client requests.
2165 zone:
2166 type: string
2167 description: |
2168 The name of the shared memory
2169 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone">zone</a>
2170 that keeps the group’s configuration and run-time state.
2171 queue:
2172 type: object
2173 description: |
2174 For the requests
2175 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#queue">queue</a>,
2176 the following data are provided:
2177 properties:
2178 size:
2179 type: integer
2180 description: |
2181 The current number of requests in the queue.
2182 max_size:
2183 type: integer
2184 description: |
2185 The maximum number of requests that can be in the queue
2186 at the same time.
2187 overflows:
2188 type: integer
2189 description: |
2190 The total number of requests rejected due to the queue overflow.
2191 example:
2192 upstream_backend:
2193 peers:
2194 - id: 0
2195 server: 10.0.0.1:8088
2196 name: 10.0.0.1:8088
2197 backup: false
2198 weight: 5
2199 state: up
2200 active: 0
2201 max_conns: 20
2202 requests: 667231
2203 header_time: 20
2204 response_time: 36
2205 responses:
2206 1xx: 0
2207 2xx: 666310
2208 3xx: 0
2209 4xx: 915
2210 5xx: 6
2211 total: 667231
2212 sent: 251946292
2213 received: 19222475454
2214 fails: 0
2215 unavail: 0
2216 health_checks:
2217 checks: 26214
2218 fails: 0
2219 unhealthy: 0
2220 last_passed: true
2221 downtime: 0
2222 downstart: 2017-07-07T11:09:21.602Z
2223 selected: 2017-07-17T15:01:25Z
2224 - id: 1
2225 server: 10.0.0.1:8089
2226 name: 10.0.0.1:8089
2227 backup: true
2228 weight: 1
2229 state: unhealthy
2230 active: 0
2231 max_conns: 20
2232 requests: 0
2233 responses:
2234 1xx: 0
2235 2xx: 0
2236 3xx: 0
2237 4xx: 0
2238 5xx: 0
2239 total: 0
2240 sent: 0
2241 received: 0
2242 fails: 0
2243 unavail: 0
2244 health_checks:
2245 checks: 26284
2246 fails: 26284
2247 unhealthy: 1
2248 last_passed: false
2249 downtime: 262925617
2250 downstart: 2017-07-07T11:09:21.602Z
2251 selected: 2017-07-17T15:01:25Z
2252 keepalive: 0
2253 zombies: 0
2254 zone: upstream_backend
2255 NginxHTTPUpstreamPeerMap:
2256 title: HTTP Upstream Servers
2257 description: |
2258 An array of HTTP
2259 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream">upstream servers</a>.
2260 type: array
2261 items:
2262 $ref: '#/definitions/NginxHTTPUpstreamPeer'
2263 NginxHTTPUpstreamPeer:
2264 title: HTTP Upstream Server
2265 type: object
2266 properties:
2267 id:
2268 type: integer
2269 description: The ID of the server.
2270 readOnly: true
2271 server:
2272 type: string
2273 description: |
2274 An <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">address</a>
2275 of the server.
2276 service:
2277 type: string
2278 description: |
2279 The
2280 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</a>
2281 parameter value of the
2282 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>
2283 directive.
2284 name:
2285 type: string
2286 description: |
2287 The name of the server specified in the
2288 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>
2289 directive.
2290 readOnly: true
2291 backup:
2292 type: boolean
2293 description: |
2294 A boolean value indicating whether the server is a
2295 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</a>
2296 server.
2297 weight:
2298 type: integer
2299 description: |
2300 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">Weight</a>
2301 of the server.
2302 state:
2303 type: string
2304 enum:
2305 - up
2306 - draining
2307 - down
2308 - unavail
2309 - checking
2310 - unhealthy
2311 description: |
2312 Current state, which may be one of
2313 “<code>up</code>”, “<code>draining</code>”, “<code>down</code>”,
2314 “<code>unavail</code>”, “<code>checking</code>”,
2315 and “<code>unhealthy</code>”.
2316 active:
2317 type: integer
2318 description: |
2319 The current number of active connections.
2320 readOnly: true
2321 max_conns:
2322 type: integer
2323 description: |
2324 The
2325 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</a>
2326 limit for the server.
2327 requests:
2328 type: integer
2329 description: |
2330 The total number of client requests forwarded to this server.
2331 readOnly: true
2332 responses:
2333 type: object
2334 readOnly: true
2335 properties:
2336 1xx:
2337 type: integer
2338 description: |
2339 The number of responses with “<code>1xx</code>” status codes.
2340 readOnly: true
2341 2xx:
2342 type: integer
2343 description: |
2344 The number of responses with “<code>2xx</code>” status codes.
2345 readOnly: true
2346 3xx:
2347 type: integer
2348 description: |
2349 The number of responses with “<code>3xx</code>” status codes.
2350 readOnly: true
2351 4xx:
2352 type: integer
2353 description: |
2354 The number of responses with “<code>4xx</code>” status codes.
2355 readOnly: true
2356 5xx:
2357 type: integer
2358 description: |
2359 The number of responses with “<code>5xx</code>” status codes.
2360 readOnly: true
2361 total:
2362 type: integer
2363 description: The total number of responses obtained from this server.
2364 readOnly: true
2365 sent:
2366 type: integer
2367 description: |
2368 The total number of bytes sent to this server.
2369 readOnly: true
2370 received:
2371 type: integer
2372 description: |
2373 The total number of bytes received from this server.
2374 readOnly: true
2375 fails:
2376 type: integer
2377 description: |
2378 The total number of unsuccessful attempts
2379 to communicate with the server.
2380 readOnly: true
2381 unavail:
2382 type: integer
2383 description: |
2384 How many times the server became unavailable for client requests
2385 (state “<code>unavail</code>”) due to the number of unsuccessful
2386 attempts reaching the
2387 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</a>
2388 threshold.
2389 readOnly: true
2390 health_checks:
2391 type: object
2392 readOnly: true
2393 properties:
2394 checks:
2395 type: integer
2396 description: |
2397 The total number of
2398 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#health_check">health check</a>
2399 requests made.
2400 fails:
2401 type: integer
2402 description: The number of failed health checks.
2403 unhealthy:
2404 type: integer
2405 description: |
2406 How many times the server became unhealthy
2407 (state “<code>unhealthy</code>”).
2408 last_passed:
2409 type: boolean
2410 description: |
2411 Boolean indicating if the last health check request was successful
2412 and passed
2413 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_hc_module.html#match">tests</a>.
2414 downtime:
2415 type: integer
2416 readOnly: true
2417 description: |
2418 Total time the server was in the “<code>unavail</code>”,
2419 “<code>checking</code>”, and “<code>unhealthy</code>” states.
2420 downstart:
2421 type: string
2422 format: date-time
2423 readOnly: true
2424 description: |
2425 The time (in milliseconds since Epoch) when the server became
2426 “<code>unavail</code>”, “<code>checking</code>”,
2427 or “<code>unhealthy</code>”.
2428 selected:
2429 type: string
2430 format: date-time
2431 readOnly: true
2432 description: |
2433 The time (in milliseconds since Epoch)
2434 when the server was last selected to process a request.
2435 header_time:
2436 type: integer
2437 readOnly: true
2438 description: |
2439 The average time to get the
2440 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_header_time">response header</a>
2441 from the server.
2442 response_time:
2443 type: integer
2444 readOnly: true
2445 description: |
2446 The average time to get the
2447 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_response_time">full response</a>
2448 from the server.
2449 NginxHTTPUpstreamConfServerMap:
2450 title: HTTP Upstream Servers
2451 description: |
2452 An array of HTTP upstream servers for dynamic configuration.
2453 type: array
2454 items:
2455 $ref: '#/definitions/NginxHTTPUpstreamConfServer'
2456 example:
2457 - id: 0
2458 server: 10.0.0.1:8088
2459 weight: 1
2460 max_conns: 0
2461 max_fails: 0
2462 fail_timeout: 10s
2463 slow_start: 10s
2464 route: ''
2465 backup: false
2466 down: false
2467 - id: 1
2468 server: 10.0.0.1:8089
2469 weight: 4
2470 max_conns: 0
2471 max_fails: 0
2472 fail_timeout: 10s
2473 slow_start: 10s
2474 route: ''
2475 backup: true
2476 down: true
2477 NginxHTTPUpstreamConfServer:
2478 title: HTTP Upstream Server
2479 description: |
2480 Dynamically configurable parameters of an HTTP upstream
2481 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#server">server</a>:
2482 type: object
2483 properties:
2484 id:
2485 type: integer
2486 description: |
2487 The ID of the HTTP upstream server.
2488 The ID is assigned automatically and cannot be changed.
2489 readOnly: true
2490 server:
2491 type: string
2492 description: |
2493 Same as the
2494 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#address">address</a>
2495 parameter of the HTTP upstream server.
2496 When adding a server, it is possible to specify it as a domain name.
2497 In this case, changes of the IP addresses
2498 that correspond to a domain name will be monitored and automatically
2499 applied to the upstream configuration
2500 without the need of restarting nginx.
2501 This requires the
2502 <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#resolver">resolver</a>
2503 directive in the “<code>http</code>” block.
2504 See also the
2505 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#resolve">resolve</a>
2506 parameter of the HTTP upstream server.
2507 service:
2508 type: string
2509 description: |
2510 Same as the
2511 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#service">service</a>
2512 parameter of the HTTP upstream server.
2513 This parameter cannot be changed.
2514 readOnly: true
2515 weight:
2516 type: integer
2517 description: |
2518 Same as the
2519 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#weight">weight</a>
2520 parameter of the HTTP upstream server.
2521 max_conns:
2522 type: integer
2523 description: |
2524 Same as the
2525 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</a>
2526 parameter of the HTTP upstream server.
2527 max_fails:
2528 type: integer
2529 description: |
2530 Same as the
2531 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_fails">max_fails</a>
2532 parameter of the HTTP upstream server.
2533 fail_timeout:
2534 type: integer
2535 description: |
2536 Same as the
2537 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#fail_timeout">fail_timeout</a>
2538 parameter of the HTTP upstream server.
2539 slow_start:
2540 type: integer
2541 description: |
2542 Same as the
2543 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#slow_start">slow_start</a>
2544 parameter of the HTTP upstream server.
2545 route:
2546 type: string
2547 description: |
2548 Same as the
2549 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#route">route</a>
2550 parameter of the HTTP upstream server.
2551 backup:
2552 type: boolean
2553 description: |
2554 When <code>true</code>, adds a
2555 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#backup">backup</a>
2556 server.
2557 This parameter cannot be changed.
2558 readOnly: true
2559 down:
2560 type: boolean
2561 description: |
2562 Same as the
2563 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#down">down</a>
2564 parameter of the HTTP upstream server.
2565 parent:
2566 type: string
2567 description: |
2568 Parent server ID of the resolved server.
2569 The ID is assigned automatically and cannot be changed.
2570 readOnly: true
2571 host:
2572 type: string
2573 description: |
2574 Hostname of the resolved server.
2575 The hostname is assigned automatically and cannot be changed.
2576 readOnly: true
2577 drain:
2578 type: string
2579 description: |
2580 Puts the HTTP upstream server into the “draining” mode.
2581 In this mode, only requests
2582 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#sticky">bound</a>
2583 to the server will be proxied to it.
2584 The parameter cannot be initially set,
2585 it can only be changed with the <code>PATCH</code> method.
2586 example:
2587 id: 1
2588 server: 10.0.0.1:8089
2589 weight: 4
2590 max_conns: 0
2591 max_fails: 0
2592 fail_timeout: 10s
2593 slow_start: 10s
2594 route: ''
2595 backup: true
2596 down: true
2597 NginxHTTPKeyvalZonesMap:
2598 title: Keyval Shared Memory Zones
2599 description: |
2600 Contents of all keyval shared memory zones.
2601 type: object
2602 additionalProperties:
2603 $ref: '#/definitions/NginxHTTPKeyvalZone'
2604 example:
2605 keyval_zone:
2606 key1: value1
2607 key2: value2
2608 key3: value3
2609 one:
2610 arg1: value1
2611 arg2: value2
2612 arg3: value3
2613 NginxHTTPKeyvalZone:
2614 title: Keyval Shared Memory Zone
2615 description: |
2616 Contents of a keyval shared memory zone.
2617 type: object
2618 example:
2619 key1: value1
2620 key2: value2
2621 key3: value3
2622 NginxStreamServerZonesMap:
2623 title: Stream Server Zones
2624 description: |
2625 Status information for all stream
2626 <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone">status zones</a>.
2627 type: object
2628 additionalProperties:
2629 $ref: '#/definitions/NginxStreamServerZone'
2630 example:
2631 mysql-frontend:
2632 processing: 2
2633 connections: 270925
2634 sessions:
2635 2xx: 155564
2636 4xx: 0
2637 5xx: 0
2638 total: 270925
2639 discarded: 0
2640 received: 28988975
2641 sent: 3879346317
2642 dns:
2643 processing: 1
2644 connections: 155569
2645 sessions:
2646 2xx: 155564
2647 4xx: 0
2648 5xx: 0
2649 total: 155569
2650 discarded: 0
2651 received: 4200363
2652 sent: 20489184
2653 NginxStreamServerZone:
2654 title: Stream Server Zone
2655 type: object
2656 properties:
2657 processing:
2658 type: integer
2659 description: |
2660 The number of client connections
2661 that are currently being processed.
2662 connections:
2663 type: integer
2664 description: |
2665 The total number of connections accepted from clients.
2666 sessions:
2667 type: object
2668 description: |
2669 Total number of completed sessions,
2670 and the number of sessions completed with status codes
2671 “<code>2xx</code>”, “<code>4xx</code>”, or “<code>5xx</code>”.
2672 properties:
2673 2xx:
2674 type: integer
2675 description: |
2676 The total number of sessions completed with
2677 <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a>
2678 “<code>2xx</code>”.
2679 4xx:
2680 type: integer
2681 description: |
2682 The total number of sessions completed with
2683 <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a>
2684 “<code>4xx</code>”.
2685 5xx:
2686 type: integer
2687 description: |
2688 The total number of sessions completed with
2689 <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#var_status">status codes</a>
2690 “<code>5xx</code>”.
2691 total:
2692 type: integer
2693 description: The total number of completed client sessions.
2694 discarded:
2695 type: integer
2696 description: |
2697 The total number of
2698 connections completed without creating a session.
2699 received:
2700 type: integer
2701 description: The total number of bytes received from clients.
2702 sent:
2703 type: integer
2704 description: The total number of bytes sent to clients.
2705 example:
2706 dns:
2707 processing: 1
2708 connections: 155569
2709 sessions:
2710 2xx: 155564
2711 4xx: 0
2712 5xx: 0
2713 total: 155569
2714 discarded: 0
2715 received: 4200363
2716 sent: 20489184
2717 NginxStreamUpstreamMap:
2718 title: Stream Upstreams
2719 description: Status information of stream upstream server groups.
2720 type: object
2721 additionalProperties:
2722 $ref: '#/definitions/NginxStreamUpstream'
2723 example:
2724 mysql_backends:
2725 peers:
2726 - id: 0
2727 server: 10.0.0.1:12345
2728 name: 10.0.0.1:12345
2729 backup: false
2730 weight: 5
2731 state: up
2732 active: 0
2733 max_conns: 30
2734 connecions: 1231
2735 sent: 251946292
2736 received: 19222475454
2737 fails: 0
2738 unavail: 0
2739 health_checks:
2740 checks: 26214
2741 fails: 0
2742 unhealthy: 0
2743 last_passed: true
2744 downtime: 0
2745 downstart: 2017-07-07T11:09:21.602Z
2746 selected: 2017-07-17T15:01:25Z
2747 - id: 1
2748 server: 10.0.0.1:12346
2749 name: 10.0.0.1:12346
2750 backup: true
2751 weight: 1
2752 state: unhealthy
2753 active: 0
2754 max_conns: 30
2755 connections: 0
2756 sent: 0
2757 received: 0
2758 fails: 0
2759 unavail: 0
2760 health_checks:
2761 checks: 26284
2762 fails: 26284
2763 unhealthy: 1
2764 last_passed: false
2765 downtime: 262925617
2766 downstart: 2017-07-07T11:09:21.602Z
2767 selected: 2017-07-17T15:01:25Z
2768 zombies: 0
2769 zone: mysql_backends
2770 dns:
2771 peers:
2772 - id: 0
2773 server: 10.0.0.1:12347
2774 name: 10.0.0.1:12347
2775 backup: false
2776 weight: 5
2777 state: up
2778 active: 0
2779 max_conns: 30
2780 connections: 667231
2781 sent: 251946292
2782 received: 19222475454
2783 fails: 0
2784 unavail: 0
2785 health_checks:
2786 checks: 26214
2787 fails: 0
2788 unhealthy: 0
2789 last_passed: true
2790 downtime: 0
2791 downstart: 2017-07-07T11:09:21.602Z
2792 selected: 2017-07-17T15:01:25Z
2793 - id: 1
2794 server: 10.0.0.1:12348
2795 name: 10.0.0.1:12348
2796 backup: true
2797 weight: 1
2798 state: unhealthy
2799 active: 0
2800 connections: 0
2801 max_conns: 30
2802 sent: 0
2803 received: 0
2804 fails: 0
2805 unavail: 0
2806 health_checks:
2807 checks: 26284
2808 fails: 26284
2809 unhealthy: 1
2810 last_passed: false
2811 downtime: 262925617
2812 downstart: 2017-07-07T11:09:21.602Z
2813 selected: 2017-07-17T15:01:25Z
2814 zombies: 0
2815 zone: dns
2816 NginxStreamUpstream:
2817 title: Stream Upstream
2818 type: object
2819 properties:
2820 peers:
2821 $ref: '#/definitions/NginxStreamUpstreamPeerMap'
2822 zombies:
2823 type: integer
2824 description: |
2825 The current number of servers removed from the group
2826 but still processing active client connections.
2827 zone:
2828 type: string
2829 description: |
2830 The name of the shared memory
2831 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#zone">zone</a>
2832 that keeps the group’s configuration and run-time state.
2833 example:
2834 dns:
2835 peers:
2836 - id: 0
2837 server: 10.0.0.1:12347
2838 name: 10.0.0.1:12347
2839 backup: false
2840 weight: 5
2841 state: up
2842 active: 0
2843 max_conns: 50
2844 connections: 667231
2845 sent: 251946292
2846 received: 19222475454
2847 fails: 0
2848 unavail: 0
2849 health_checks:
2850 checks: 26214
2851 fails: 0
2852 unhealthy: 0
2853 last_passed: true
2854 downtime: 0
2855 downstart: 2017-07-07T11:09:21.602Z
2856 selected: 2017-07-17T15:01:25Z
2857 - id: 1
2858 server: 10.0.0.1:12348
2859 name: 10.0.0.1:12348
2860 backup: true
2861 weight: 1
2862 state: unhealthy
2863 active: 0
2864 max_conns: 50
2865 connections: 0
2866 sent: 0
2867 received: 0
2868 fails: 0
2869 unavail: 0
2870 health_checks:
2871 checks: 26284
2872 fails: 26284
2873 unhealthy: 1
2874 last_passed: false
2875 downtime: 262925617
2876 downstart: 2017-07-07T11:09:21.602Z
2877 selected: 2017-07-17T15:01:25Z
2878 zombies: 0
2879 zone: dns
2880 NginxStreamUpstreamPeerMap:
2881 title: Stream Upstream Servers
2882 description: Array of stream upstream servers.
2883 type: array
2884 items:
2885 $ref: '#/definitions/NginxStreamUpstreamPeer'
2886 NginxStreamUpstreamPeer:
2887 title: Stream Upstream Server
2888 type: object
2889 properties:
2890 id:
2891 type: integer
2892 description: |
2893 The ID of the server.
2894 readOnly: true
2895 server:
2896 type: string
2897 description: |
2898 An
2899 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</a>
2900 of the server.
2901 service:
2902 type: string
2903 description: |
2904 The
2905 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</a>
2906 parameter value of the
2907 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>
2908 directive.
2909 name:
2910 type: string
2911 format: hostname
2912 description: |
2913 The name of the server specified in the
2914 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>
2915 directive.
2916 readOnly: true
2917 backup:
2918 type: boolean
2919 description: |
2920 A boolean value indicating whether the server is a
2921 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</a>
2922 server.
2923 weight:
2924 type: integer
2925 description: |
2926 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">Weight</a>
2927 of the server.
2928 state:
2929 type: string
2930 readOnly: true
2931 enum:
2932 - up
2933 - down
2934 - unavail
2935 - checking
2936 - unhealthy
2937 description: |
2938 Current state, which may be one of
2939 “<code>up</code>”, “<code>down</code>”, “<code>unavail</code>”,
2940 “<code>checking</code>”, or “<code>unhealthy</code>”.
2941 active:
2942 type: integer
2943 description: The current number of connections.
2944 readOnly: true
2945 max_conns:
2946 type: integer
2947 description: |
2948 The
2949 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</a>
2950 limit for the server.
2951 connections:
2952 type: integer
2953 description: |
2954 The total number of client connections forwarded to this server.
2955 readOnly: true
2956 connect_time:
2957 type: integer
2958 description: The average time to connect to the upstream server.
2959 readOnly: true
2960 first_byte_time:
2961 type: integer
2962 description: The average time to receive the first byte of data.
2963 readOnly: true
2964 response_time:
2965 type: integer
2966 description: The average time to receive the last byte of data.
2967 readOnly: true
2968 sent:
2969 type: integer
2970 description: The total number of bytes sent to this server.
2971 readOnly: true
2972 received:
2973 type: integer
2974 description: |
2975 The total number of bytes received from this server.
2976 readOnly: true
2977 fails:
2978 type: integer
2979 description: |
2980 The total number of unsuccessful attempts
2981 to communicate with the server.
2982 readOnly: true
2983 unavail:
2984 type: integer
2985 description: |
2986 How many times the server became unavailable for client connections
2987 (state “<code>unavail</code>”) due to the number of unsuccessful
2988 attempts reaching the
2989 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</a>
2990 threshold.
2991 readOnly: true
2992 health_checks:
2993 type: object
2994 description: |
2995 readOnly: true
2996 properties:
2997 checks:
2998 type: integer
2999 description: |
3000 The total number of
3001 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#health_check">health check</a>
3002 requests made.
3003 readOnly: true
3004 fails:
3005 type: integer
3006 description: The number of failed health checks.
3007 readOnly: true
3008 unhealthy:
3009 type: integer
3010 description: |
3011 How many times the server became unhealthy
3012 (state “<code>unhealthy</code>”).
3013 readOnly: true
3014 last_passed:
3015 type: boolean
3016 description: |
3017 Boolean indicating whether the last health check request
3018 was successful and passed
3019 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html#match">tests</a>.
3020 readOnly: true
3021 downtime:
3022 type: integer
3023 description: |
3024 Total time the server was in the
3025 “<code>unavail</code>”, “<code>checking</code>”,
3026 and “<code>unhealthy</code>” states.
3027 readOnly: true
3028 downstart:
3029 type: string
3030 format: date-time
3031 description: |
3032 The time (in milliseconds since Epoch) when the server became
3033 “<code>unavail</code>”, “<code>checking</code>”,
3034 or “<code>unhealthy</code>”.
3035 readOnly: true
3036 selected:
3037 type: string
3038 format: date-time
3039 description: |
3040 The time (in milliseconds since Epoch)
3041 when the server was last selected to process a connection.
3042 readOnly: true
3043 NginxStreamUpstreamConfServerMap:
3044 title: Stream Upstream Servers
3045 description: |
3046 An array of stream upstream servers for dynamic configuration.
3047 type: array
3048 items:
3049 $ref: '#/definitions/NginxStreamUpstreamConfServer'
3050 example:
3051 - id: 0
3052 server: 10.0.0.1:12348
3053 weight: 1
3054 max_conns: 0
3055 max_fails: 1
3056 fail_timeout: 10s
3057 slow_start: 0
3058 backup: false
3059 down: false
3060 - id: 1
3061 server: 10.0.0.1:12349
3062 weight: 1
3063 max_conns: 0
3064 max_fails: 1
3065 fail_timeout: 10s
3066 slow_start: 0
3067 backup: false
3068 down: false
3069 NginxStreamUpstreamConfServer:
3070 title: Stream Upstream Server
3071 description: |
3072 Dynamically configurable parameters of a stream upstream
3073 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">server</a>:
3074 type: object
3075 properties:
3076 id:
3077 type: integer
3078 description: |
3079 The ID of the stream upstream server.
3080 The ID is assigned automatically and cannot be changed.
3081 readOnly: true
3082 server:
3083 type: string
3084 description: |
3085 Same as the
3086 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#server">address</a>
3087 parameter of the stream upstream server.
3088 When adding a server, it is possible to specify it as a domain name.
3089 In this case, changes of the IP addresses
3090 that correspond to a domain name will be monitored and automatically
3091 applied to the upstream configuration
3092 without the need of restarting nginx.
3093 This requires the
3094 <a href="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#resolver">resolver</a>
3095 directive in the “<code>stream</code>” block.
3096 See also the
3097 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#resolve">resolve</a>
3098 parameter of the stream upstream server.
3099 service:
3100 type: string
3101 description: |
3102 Same as the
3103 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#service">service</a>
3104 parameter of the stream upstream server.
3105 This parameter cannot be changed.
3106 readOnly: true
3107 weight:
3108 type: integer
3109 description: |
3110 Same as the
3111 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#weight">weight</a>
3112 parameter of the stream upstream server.
3113 max_conns:
3114 type: integer
3115 description: |
3116 Same as the
3117 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</a>
3118 parameter of the stream upstream server.
3119 max_fails:
3120 type: integer
3121 description: |
3122 Same as the
3123 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_fails">max_fails</a>
3124 parameter of the stream upstream server.
3125 fail_timeout:
3126 type: integer
3127 description: |
3128 Same as the
3129 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#fail_timeout">fail_timeout</a>
3130 parameter of the stream upstream server.
3131 slow_start:
3132 type: integer
3133 description: |
3134 Same as the
3135 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#slow_start">slow_start</a>
3136 parameter of the stream upstream server.
3137 backup:
3138 type: boolean
3139 description: |
3140 When <code>true</code>, adds a
3141 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#backup">backup</a>
3142 server.
3143 This parameter cannot be changed.
3144 readOnly: true
3145 down:
3146 type: boolean
3147 description: |
3148 Same as the
3149 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#down">down</a>
3150 parameter of the stream upstream server.
3151 parent:
3152 type: string
3153 description: |
3154 Parent server ID of the resolved server.
3155 The ID is assigned automatically and cannot be changed.
3156 readOnly: true
3157 host:
3158 type: string
3159 description: |
3160 Hostname of the resolved server.
3161 The hostname is assigned automatically and cannot be changed.
3162 readOnly: true
3163 example:
3164 id: 0
3165 server: 10.0.0.1:12348
3166 weight: 1
3167 max_conns: 0
3168 max_fails: 1
3169 fail_timeout: 10s
3170 slow_start: 0
3171 backup: false
3172 down: false
3173 NginxError:
3174 title: Error
3175 description: |
3176 nginx error object.
3177 type: object
3178 properties:
3179 path:
3180 type: string
3181 description: |
3182 API path.
3183 method:
3184 type: string
3185 description: |
3186 HTTP method.
3187 error:
3188 type: object
3189 properties:
3190 status:
3191 type: string
3192 description: |
3193 HTTP error code.
3194 text:
3195 type: string
3196 description: |
3197 Error description.
3198 code:
3199 type: string
3200 description: |
3201 Internal nginx error code.
3202 request_id:
3203 type: string
3204 description: |
3205 The ID of the request, equals the value of the
3206 <a href="https://nginx.org/en/docs/http/ngx_http_core_module.html#var_request_id">$request_id</a>
3207 variable.
3208 href:
3209 type: string
3210 description: |
3211 Link to reference documentation.