Mercurial > hg > nginx-site
comparison yaml/nginx_api.yaml @ 2866:8bd6f772005f
Updated docs for the upcoming NGINX Plus release.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Sat, 25 Jun 2022 18:55:17 +0100 |
parents | 9dd8c203a54a |
children | 3a2d342533fb |
comparison
equal
deleted
inserted
replaced
2865:0d355d154181 | 2866:8bd6f772005f |
---|---|
1 swagger: '2.0' | 1 swagger: '2.0' |
2 info: | 2 info: |
3 version: '7.0' | 3 version: '8.0' |
4 title: NGINX Plus REST API | 4 title: NGINX Plus REST API |
5 description: NGINX Plus REST | 5 description: NGINX Plus REST |
6 [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) |
7 provides access to NGINX Plus status information, | 7 provides access to NGINX Plus status information, |
8 on-the-fly configuration of upstream servers and | 8 on-the-fly configuration of upstream servers and |
9 key-value pairs management for | 9 key-value pairs management for |
10 [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and | 10 [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and |
11 [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html). | 11 [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html). |
12 basePath: /api/7 | 12 basePath: /api/8 |
13 tags: | 13 tags: |
14 - name: General Info | 14 - name: General Info |
15 - name: Processes | 15 - name: Processes |
16 - name: Connections | 16 - name: Connections |
17 - name: Slabs | 17 - name: Slabs |
372 tags: | 372 tags: |
373 - HTTP Server Zones | 373 - HTTP Server Zones |
374 - Method DELETE | 374 - Method DELETE |
375 summary: Reset statistics for an HTTP server zone | 375 summary: Reset statistics for an HTTP server zone |
376 description: Resets statistics of accepted and discarded requests, responses, | 376 description: Resets statistics of accepted and discarded requests, responses, |
377 received and sent bytes in a particular HTTP server zone. | 377 received and sent bytes, counters of SSL handshakes and session reuses |
378 in a particular HTTP server zone. | |
378 operationId: deleteHttpServerZoneStat | 379 operationId: deleteHttpServerZoneStat |
379 responses: | 380 responses: |
380 '204': | 381 '204': |
381 description: Success | 382 description: Success |
382 '404': | 383 '404': |
1328 tags: | 1329 tags: |
1329 - Stream Server Zones | 1330 - Stream Server Zones |
1330 - Method DELETE | 1331 - Method DELETE |
1331 summary: Reset statistics for a stream server zone | 1332 summary: Reset statistics for a stream server zone |
1332 description: Resets statistics of accepted and discarded connections, sessions, | 1333 description: Resets statistics of accepted and discarded connections, sessions, |
1333 received and sent bytes in a particular stream server zone. | 1334 received and sent bytes, counters of SSL handshakes and session reuses |
1335 in a particular stream server zone. | |
1334 operationId: deleteStreamServerZoneStat | 1336 operationId: deleteStreamServerZoneStat |
1335 responses: | 1337 responses: |
1336 '204': | 1338 '204': |
1337 description: Success | 1339 description: Success |
1338 '404': | 1340 '404': |
2146 type: integer | 2148 type: integer |
2147 description: The ID of the master process that started the | 2149 description: The ID of the master process that started the |
2148 <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</a>. | 2150 <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</a>. |
2149 example: | 2151 example: |
2150 nginx: | 2152 nginx: |
2151 version: 1.17.3 | 2153 version: 1.21.6 |
2152 build: nginx-plus-r19 | 2154 build: nginx-plus-r27 |
2153 address: 206.251.255.64 | 2155 address: 206.251.255.64 |
2154 generation: 6 | 2156 generation: 6 |
2155 load_timestamp: 2019-10-01T11:15:44.467Z | 2157 load_timestamp: 2022-06-28T11:15:44.467Z |
2156 timestamp: 2019-10-01T09:26:07.305Z | 2158 timestamp: 2022-06-28T09:26:07.305Z |
2157 pid: 32212 | 2159 pid: 32212 |
2158 ppid: 32210 | 2160 ppid: 32210 |
2159 NginxProcesses: | 2161 NginxProcesses: |
2160 title: Processes | 2162 title: Processes |
2161 type: object | 2163 type: object |
2391 503: 1535 | 2393 503: 1535 |
2392 total: 734373 | 2394 total: 734373 |
2393 discarded: 2020 | 2395 discarded: 2020 |
2394 received: 180157219 | 2396 received: 180157219 |
2395 sent: 20183175459 | 2397 sent: 20183175459 |
2398 ssl: | |
2399 handshakes: 65432 | |
2400 handshakes_failed: 421 | |
2401 session_reuses: 4645 | |
2396 site2: | 2402 site2: |
2397 processing: 1 | 2403 processing: 1 |
2398 requests: 185307 | 2404 requests: 185307 |
2399 responses: | 2405 responses: |
2400 1xx: 0 | 2406 1xx: 0 |
2409 503: 4419 | 2415 503: 4419 |
2410 total: 164980 | 2416 total: 164980 |
2411 discarded: 20326 | 2417 discarded: 20326 |
2412 received: 51575327 | 2418 received: 51575327 |
2413 sent: 2983241510 | 2419 sent: 2983241510 |
2420 ssl: | |
2421 handshakes: 104303 | |
2422 handshakes_failed: 1421 | |
2423 session_reuses: 54645 | |
2414 NginxHTTPServerZone: | 2424 NginxHTTPServerZone: |
2415 title: HTTP Server Zone | 2425 title: HTTP Server Zone |
2416 type: object | 2426 type: object |
2417 properties: | 2427 properties: |
2418 processing: | 2428 processing: |
2472 type: integer | 2482 type: integer |
2473 description: The total number of bytes received from clients. | 2483 description: The total number of bytes received from clients. |
2474 sent: | 2484 sent: |
2475 type: integer | 2485 type: integer |
2476 description: The total number of bytes sent to clients. | 2486 description: The total number of bytes sent to clients. |
2487 ssl: | |
2488 type: object | |
2489 readOnly: true | |
2490 properties: | |
2491 handshakes: | |
2492 type: integer | |
2493 description: The total number of successful SSL handshakes. | |
2494 readOnly: true | |
2495 handshakes_failed: | |
2496 type: integer | |
2497 description: The total number of failed SSL handshakes. | |
2498 readOnly: true | |
2499 session_reuses: | |
2500 type: integer | |
2501 description: The total number of session reuses during SSL handshake. | |
2502 readOnly: true | |
2477 example: | 2503 example: |
2478 processing: 1 | 2504 processing: 1 |
2479 requests: 706690 | 2505 requests: 706690 |
2480 responses: | 2506 responses: |
2481 1xx: 0 | 2507 1xx: 0 |
2490 503: 266 | 2516 503: 266 |
2491 total: 705177 | 2517 total: 705177 |
2492 discarded: 1513 | 2518 discarded: 1513 |
2493 received: 172711587 | 2519 received: 172711587 |
2494 sent: 19415530115 | 2520 sent: 19415530115 |
2521 ssl: | |
2522 handshakes: 104303 | |
2523 handshakes_failed: 1421 | |
2524 session_reuses: 54645 | |
2495 NginxHTTPLocationZonesMap: | 2525 NginxHTTPLocationZonesMap: |
2496 title: HTTP Location Zones | 2526 title: HTTP Location Zones |
2497 description: | | 2527 description: | |
2498 Status data for all HTTP | 2528 Status data for all HTTP |
2499 <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">location zones</a>. | 2529 <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">location zones</a>. |
2899 name: 10.0.0.1:8088 | 2929 name: 10.0.0.1:8088 |
2900 backup: false | 2930 backup: false |
2901 weight: 5 | 2931 weight: 5 |
2902 state: up | 2932 state: up |
2903 active: 0 | 2933 active: 0 |
2934 ssl: | |
2935 handshakes: 620311 | |
2936 handshakes_failed: 3432 | |
2937 session_reuses: 36442 | |
2904 requests: 667231 | 2938 requests: 667231 |
2905 header_time: 20 | 2939 header_time: 20 |
2906 response_time: 36 | 2940 response_time: 36 |
2907 responses: | 2941 responses: |
2908 1xx: 0 | 2942 1xx: 0 |
2923 checks: 26214 | 2957 checks: 26214 |
2924 fails: 0 | 2958 fails: 0 |
2925 unhealthy: 0 | 2959 unhealthy: 0 |
2926 last_passed: true | 2960 last_passed: true |
2927 downtime: 0 | 2961 downtime: 0 |
2928 downstart: 2019-10-01T11:09:21.602Z | 2962 downstart: 2022-06-28T11:09:21.602Z |
2929 selected: 2019-10-01T15:01:25Z | 2963 selected: 2022-06-28T15:01:25Z |
2930 - id: 1 | 2964 - id: 1 |
2931 server: 10.0.0.1:8089 | 2965 server: 10.0.0.1:8089 |
2932 name: 10.0.0.1:8089 | 2966 name: 10.0.0.1:8089 |
2933 backup: true | 2967 backup: true |
2934 weight: 1 | 2968 weight: 1 |
2951 checks: 26284 | 2985 checks: 26284 |
2952 fails: 26284 | 2986 fails: 26284 |
2953 unhealthy: 1 | 2987 unhealthy: 1 |
2954 last_passed: false | 2988 last_passed: false |
2955 downtime: 262925617 | 2989 downtime: 262925617 |
2956 downstart: 2019-10-01T11:09:21.602Z | 2990 downstart: 2022-06-28T11:09:21.602Z |
2957 selected: 2019-10-01T15:01:25Z | 2991 selected: 2022-06-28T15:01:25Z |
2958 keepalive: 0 | 2992 keepalive: 0 |
2959 zombies: 0 | 2993 zombies: 0 |
2960 zone: trac-backend | 2994 zone: trac-backend |
2961 hg-backend: | 2995 hg-backend: |
2962 peers: | 2996 peers: |
2965 name: 10.0.0.1:8088 | 2999 name: 10.0.0.1:8088 |
2966 backup: false | 3000 backup: false |
2967 weight: 5 | 3001 weight: 5 |
2968 state: up | 3002 state: up |
2969 active: 0 | 3003 active: 0 |
3004 ssl: | |
3005 handshakes: 620311 | |
3006 handshakes_failed: 3432 | |
3007 session_reuses: 36442 | |
2970 requests: 667231 | 3008 requests: 667231 |
2971 header_time: 20 | 3009 header_time: 20 |
2972 response_time: 36 | 3010 response_time: 36 |
2973 responses: | 3011 responses: |
2974 1xx: 0 | 3012 1xx: 0 |
2989 checks: 26214 | 3027 checks: 26214 |
2990 fails: 0 | 3028 fails: 0 |
2991 unhealthy: 0 | 3029 unhealthy: 0 |
2992 last_passed: true | 3030 last_passed: true |
2993 downtime: 0 | 3031 downtime: 0 |
2994 downstart: 2019-10-01T11:09:21.602Z | 3032 downstart: 2022-06-28T11:09:21.602Z |
2995 selected: 2019-10-01T15:01:25Z | 3033 selected: 2022-06-28T15:01:25Z |
2996 - id: 1 | 3034 - id: 1 |
2997 server: 10.0.0.1:8089 | 3035 server: 10.0.0.1:8089 |
2998 name: 10.0.0.1:8089 | 3036 name: 10.0.0.1:8089 |
2999 backup: true | 3037 backup: true |
3000 weight: 1 | 3038 weight: 1 |
3017 checks: 26284 | 3055 checks: 26284 |
3018 fails: 26284 | 3056 fails: 26284 |
3019 unhealthy: 1 | 3057 unhealthy: 1 |
3020 last_passed: false | 3058 last_passed: false |
3021 downtime: 262925617 | 3059 downtime: 262925617 |
3022 downstart: 2019-10-01T11:09:21.602Z | 3060 downstart: 2022-06-28T11:09:21.602Z |
3023 selected: 2019-10-01T15:01:25Z | 3061 selected: 2022-06-28T15:01:25Z |
3024 keepalive: 0 | 3062 keepalive: 0 |
3025 zombies: 0 | 3063 zombies: 0 |
3026 zone: hg-backend | 3064 zone: hg-backend |
3027 NginxHTTPUpstream: | 3065 NginxHTTPUpstream: |
3028 title: HTTP Upstream | 3066 title: HTTP Upstream |
3069 name: 10.0.0.1:8088 | 3107 name: 10.0.0.1:8088 |
3070 backup: false | 3108 backup: false |
3071 weight: 5 | 3109 weight: 5 |
3072 state: up | 3110 state: up |
3073 active: 0 | 3111 active: 0 |
3112 ssl: | |
3113 handshakes: 620311 | |
3114 handshakes_failed: 3432 | |
3115 session_reuses: 36442 | |
3074 max_conns: 20 | 3116 max_conns: 20 |
3075 requests: 667231 | 3117 requests: 667231 |
3076 header_time: 20 | 3118 header_time: 20 |
3077 response_time: 36 | 3119 response_time: 36 |
3078 responses: | 3120 responses: |
3094 checks: 26214 | 3136 checks: 26214 |
3095 fails: 0 | 3137 fails: 0 |
3096 unhealthy: 0 | 3138 unhealthy: 0 |
3097 last_passed: true | 3139 last_passed: true |
3098 downtime: 0 | 3140 downtime: 0 |
3099 downstart: 2019-10-01T11:09:21.602Z | 3141 downstart: 2022-06-28T11:09:21.602Z |
3100 selected: 2019-10-01T15:01:25Z | 3142 selected: 2022-06-28T15:01:25Z |
3101 - id: 1 | 3143 - id: 1 |
3102 server: 10.0.0.1:8089 | 3144 server: 10.0.0.1:8089 |
3103 name: 10.0.0.1:8089 | 3145 name: 10.0.0.1:8089 |
3104 backup: true | 3146 backup: true |
3105 weight: 1 | 3147 weight: 1 |
3123 checks: 26284 | 3165 checks: 26284 |
3124 fails: 26284 | 3166 fails: 26284 |
3125 unhealthy: 1 | 3167 unhealthy: 1 |
3126 last_passed: false | 3168 last_passed: false |
3127 downtime: 262925617 | 3169 downtime: 262925617 |
3128 downstart: 2019-10-01T11:09:21.602Z | 3170 downstart: 2022-06-28T11:09:21.602Z |
3129 selected: 2019-10-01T15:01:25Z | 3171 selected: 2022-06-28T15:01:25Z |
3130 keepalive: 0 | 3172 keepalive: 0 |
3131 zombies: 0 | 3173 zombies: 0 |
3132 zone: upstream_backend | 3174 zone: upstream_backend |
3133 NginxHTTPUpstreamPeerMap: | 3175 NginxHTTPUpstreamPeerMap: |
3134 title: HTTP Upstream Servers | 3176 title: HTTP Upstream Servers |
3187 and “<code>unhealthy</code>”. | 3229 and “<code>unhealthy</code>”. |
3188 active: | 3230 active: |
3189 type: integer | 3231 type: integer |
3190 description: The current number of active connections. | 3232 description: The current number of active connections. |
3191 readOnly: true | 3233 readOnly: true |
3234 ssl: | |
3235 type: object | |
3236 readOnly: true | |
3237 properties: | |
3238 handshakes: | |
3239 type: integer | |
3240 description: The total number of successful SSL handshakes. | |
3241 readOnly: true | |
3242 handshakes_failed: | |
3243 type: integer | |
3244 description: The total number of failed SSL handshakes. | |
3245 readOnly: true | |
3246 session_reuses: | |
3247 type: integer | |
3248 description: The total number of session reuses during SSL handshake. | |
3249 readOnly: true | |
3192 max_conns: | 3250 max_conns: |
3193 type: integer | 3251 type: integer |
3194 description: The | 3252 description: The |
3195 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</a> | 3253 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#max_conns">max_conns</a> |
3196 limit for the server. | 3254 limit for the server. |
3494 5xx: 0 | 3552 5xx: 0 |
3495 total: 270925 | 3553 total: 270925 |
3496 discarded: 0 | 3554 discarded: 0 |
3497 received: 28988975 | 3555 received: 28988975 |
3498 sent: 3879346317 | 3556 sent: 3879346317 |
3557 ssl: | |
3558 handshakes: 76455 | |
3559 handshakes_failed: 432 | |
3560 session_reuses: 28770 | |
3499 dns: | 3561 dns: |
3500 processing: 1 | 3562 processing: 1 |
3501 connections: 155569 | 3563 connections: 155569 |
3502 sessions: | 3564 sessions: |
3503 2xx: 155564 | 3565 2xx: 155564 |
3505 5xx: 0 | 3567 5xx: 0 |
3506 total: 155569 | 3568 total: 155569 |
3507 discarded: 0 | 3569 discarded: 0 |
3508 received: 4200363 | 3570 received: 4200363 |
3509 sent: 20489184 | 3571 sent: 20489184 |
3572 ssl: | |
3573 handshakes: 2040 | |
3574 handshakes_failed: 23 | |
3575 session_reuses: 65 | |
3510 NginxStreamServerZone: | 3576 NginxStreamServerZone: |
3511 title: Stream Server Zone | 3577 title: Stream Server Zone |
3512 type: object | 3578 type: object |
3513 properties: | 3579 properties: |
3514 processing: | 3580 processing: |
3550 type: integer | 3616 type: integer |
3551 description: The total number of bytes received from clients. | 3617 description: The total number of bytes received from clients. |
3552 sent: | 3618 sent: |
3553 type: integer | 3619 type: integer |
3554 description: The total number of bytes sent to clients. | 3620 description: The total number of bytes sent to clients. |
3621 ssl: | |
3622 type: object | |
3623 readOnly: true | |
3624 properties: | |
3625 handshakes: | |
3626 type: integer | |
3627 description: The total number of successful SSL handshakes. | |
3628 readOnly: true | |
3629 handshakes_failed: | |
3630 type: integer | |
3631 description: The total number of failed SSL handshakes. | |
3632 readOnly: true | |
3633 session_reuses: | |
3634 type: integer | |
3635 description: The total number of session reuses during SSL handshake. | |
3636 readOnly: true | |
3555 example: | 3637 example: |
3556 dns: | 3638 dns: |
3557 processing: 1 | 3639 processing: 1 |
3558 connections: 155569 | 3640 connections: 155569 |
3559 sessions: | 3641 sessions: |
3562 5xx: 0 | 3644 5xx: 0 |
3563 total: 155569 | 3645 total: 155569 |
3564 discarded: 0 | 3646 discarded: 0 |
3565 received: 4200363 | 3647 received: 4200363 |
3566 sent: 20489184 | 3648 sent: 20489184 |
3649 ssl: | |
3650 handshakes: 76455 | |
3651 handshakes_failed: 432 | |
3652 session_reuses: 28770 | |
3567 NginxStreamLimitConnZonesMap: | 3653 NginxStreamLimitConnZonesMap: |
3568 title: Stream limit_conns | 3654 title: Stream limit_conns |
3569 description: | | 3655 description: | |
3570 Status data for all stream | 3656 Status data for all stream |
3571 <a href="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zones</a>. | 3657 <a href="https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zones</a>. |
3606 name: 10.0.0.1:12345 | 3692 name: 10.0.0.1:12345 |
3607 backup: false | 3693 backup: false |
3608 weight: 5 | 3694 weight: 5 |
3609 state: up | 3695 state: up |
3610 active: 0 | 3696 active: 0 |
3697 ssl: | |
3698 handshakes: 1045 | |
3699 handshakes_failed: 89 | |
3700 session_reuses: 321 | |
3611 max_conns: 30 | 3701 max_conns: 30 |
3612 connecions: 1231 | 3702 connecions: 1231 |
3613 sent: 251946292 | 3703 sent: 251946292 |
3614 received: 19222475454 | 3704 received: 19222475454 |
3615 fails: 0 | 3705 fails: 0 |
3618 checks: 26214 | 3708 checks: 26214 |
3619 fails: 0 | 3709 fails: 0 |
3620 unhealthy: 0 | 3710 unhealthy: 0 |
3621 last_passed: true | 3711 last_passed: true |
3622 downtime: 0 | 3712 downtime: 0 |
3623 downstart: 2019-10-01T11:09:21.602Z | 3713 downstart: 2022-06-28T11:09:21.602Z |
3624 selected: 2019-10-01T15:01:25Z | 3714 selected: 2022-06-28T15:01:25Z |
3625 - id: 1 | 3715 - id: 1 |
3626 server: 10.0.0.1:12346 | 3716 server: 10.0.0.1:12346 |
3627 name: 10.0.0.1:12346 | 3717 name: 10.0.0.1:12346 |
3628 backup: true | 3718 backup: true |
3629 weight: 1 | 3719 weight: 1 |
3639 checks: 26284 | 3729 checks: 26284 |
3640 fails: 26284 | 3730 fails: 26284 |
3641 unhealthy: 1 | 3731 unhealthy: 1 |
3642 last_passed: false | 3732 last_passed: false |
3643 downtime: 262925617 | 3733 downtime: 262925617 |
3644 downstart: 2019-10-01T11:09:21.602Z | 3734 downstart: 2022-06-28T11:09:21.602Z |
3645 selected: 2019-10-01T15:01:25Z | 3735 selected: 2022-06-28T15:01:25Z |
3646 zombies: 0 | 3736 zombies: 0 |
3647 zone: mysql_backends | 3737 zone: mysql_backends |
3648 dns: | 3738 dns: |
3649 peers: | 3739 peers: |
3650 - id: 0 | 3740 - id: 0 |
3652 name: 10.0.0.1:12347 | 3742 name: 10.0.0.1:12347 |
3653 backup: false | 3743 backup: false |
3654 weight: 5 | 3744 weight: 5 |
3655 state: up | 3745 state: up |
3656 active: 0 | 3746 active: 0 |
3747 ssl: | |
3748 handshakes: 5268 | |
3749 handshakes_failed: 121 | |
3750 session_reuses: 854 | |
3657 max_conns: 30 | 3751 max_conns: 30 |
3658 connections: 667231 | 3752 connections: 667231 |
3659 sent: 251946292 | 3753 sent: 251946292 |
3660 received: 19222475454 | 3754 received: 19222475454 |
3661 fails: 0 | 3755 fails: 0 |
3664 checks: 26214 | 3758 checks: 26214 |
3665 fails: 0 | 3759 fails: 0 |
3666 unhealthy: 0 | 3760 unhealthy: 0 |
3667 last_passed: true | 3761 last_passed: true |
3668 downtime: 0 | 3762 downtime: 0 |
3669 downstart: 2019-10-01T11:09:21.602Z | 3763 downstart: 2022-06-28T11:09:21.602Z |
3670 selected: 2019-10-01T15:01:25Z | 3764 selected: 2022-06-28T15:01:25Z |
3671 - id: 1 | 3765 - id: 1 |
3672 server: 10.0.0.1:12348 | 3766 server: 10.0.0.1:12348 |
3673 name: 10.0.0.1:12348 | 3767 name: 10.0.0.1:12348 |
3674 backup: true | 3768 backup: true |
3675 weight: 1 | 3769 weight: 1 |
3685 checks: 26284 | 3779 checks: 26284 |
3686 fails: 26284 | 3780 fails: 26284 |
3687 unhealthy: 1 | 3781 unhealthy: 1 |
3688 last_passed: false | 3782 last_passed: false |
3689 downtime: 262925617 | 3783 downtime: 262925617 |
3690 downstart: 2019-10-01T11:09:21.602Z | 3784 downstart: 2022-06-28T11:09:21.602Z |
3691 selected: 2019-10-01T15:01:25Z | 3785 selected: 2022-06-28T15:01:25Z |
3692 zombies: 0 | 3786 zombies: 0 |
3693 zone: dns | 3787 zone: dns |
3694 NginxStreamUpstream: | 3788 NginxStreamUpstream: |
3695 title: Stream Upstream | 3789 title: Stream Upstream |
3696 type: object | 3790 type: object |
3714 name: 10.0.0.1:12347 | 3808 name: 10.0.0.1:12347 |
3715 backup: false | 3809 backup: false |
3716 weight: 5 | 3810 weight: 5 |
3717 state: up | 3811 state: up |
3718 active: 0 | 3812 active: 0 |
3813 ssl: | |
3814 handshakes: 200 | |
3815 handshakes_failed: 4 | |
3816 session_reuses: 189 | |
3719 max_conns: 50 | 3817 max_conns: 50 |
3720 connections: 667231 | 3818 connections: 667231 |
3721 sent: 251946292 | 3819 sent: 251946292 |
3722 received: 19222475454 | 3820 received: 19222475454 |
3723 fails: 0 | 3821 fails: 0 |
3726 checks: 26214 | 3824 checks: 26214 |
3727 fails: 0 | 3825 fails: 0 |
3728 unhealthy: 0 | 3826 unhealthy: 0 |
3729 last_passed: true | 3827 last_passed: true |
3730 downtime: 0 | 3828 downtime: 0 |
3731 downstart: 2019-10-01T11:09:21.602Z | 3829 downstart: 2022-06-28T11:09:21.602Z |
3732 selected: 2019-10-01T15:01:25Z | 3830 selected: 2022-06-28T15:01:25Z |
3733 - id: 1 | 3831 - id: 1 |
3734 server: 10.0.0.1:12348 | 3832 server: 10.0.0.1:12348 |
3735 name: 10.0.0.1:12348 | 3833 name: 10.0.0.1:12348 |
3736 backup: true | 3834 backup: true |
3737 weight: 1 | 3835 weight: 1 |
3747 checks: 26284 | 3845 checks: 26284 |
3748 fails: 26284 | 3846 fails: 26284 |
3749 unhealthy: 1 | 3847 unhealthy: 1 |
3750 last_passed: false | 3848 last_passed: false |
3751 downtime: 262925617 | 3849 downtime: 262925617 |
3752 downstart: 2019-10-01T11:09:21.602Z | 3850 downstart: 2022-06-28T11:09:21.602Z |
3753 selected: 2019-10-01T15:01:25Z | 3851 selected: 2022-06-28T15:01:25Z |
3754 zombies: 0 | 3852 zombies: 0 |
3755 zone: dns | 3853 zone: dns |
3756 NginxStreamUpstreamPeerMap: | 3854 NginxStreamUpstreamPeerMap: |
3757 title: Stream Upstream Servers | 3855 title: Stream Upstream Servers |
3758 description: Array of stream upstream servers. | 3856 description: Array of stream upstream servers. |
3809 “<code>checking</code>”, or “<code>unhealthy</code>”. | 3907 “<code>checking</code>”, or “<code>unhealthy</code>”. |
3810 active: | 3908 active: |
3811 type: integer | 3909 type: integer |
3812 description: The current number of connections. | 3910 description: The current number of connections. |
3813 readOnly: true | 3911 readOnly: true |
3912 ssl: | |
3913 type: object | |
3914 readOnly: true | |
3915 properties: | |
3916 handshakes: | |
3917 type: integer | |
3918 description: The total number of successful SSL handshakes. | |
3919 readOnly: true | |
3920 handshakes_failed: | |
3921 type: integer | |
3922 description: The total number of failed SSL handshakes. | |
3923 readOnly: true | |
3924 session_reuses: | |
3925 type: integer | |
3926 description: The total number of session reuses during SSL handshake. | |
3927 readOnly: true | |
3814 max_conns: | 3928 max_conns: |
3815 type: integer | 3929 type: integer |
3816 description: The | 3930 description: The |
3817 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</a> | 3931 <a href="https://nginx.org/en/docs/stream/ngx_stream_upstream_module.html#max_conns">max_conns</a> |
3818 limit for the server. | 3932 limit for the server. |