Mercurial > hg > nginx-site

comparison yaml/nginx_api.yaml @ 2046:a810103f8a75

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