Mercurial > hg > nginx-site
diff 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 |
line wrap: on
line diff
--- a/yaml/nginx_api.yaml +++ b/yaml/nginx_api.yaml @@ -1,6 +1,6 @@ swagger: '2.0' info: - version: '7.0' + version: '8.0' title: NGINX Plus REST API description: NGINX Plus REST [API](https://nginx.org/en/docs/http/ngx_http_api_module.html) @@ -9,7 +9,7 @@ info: key-value pairs management for [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html). -basePath: /api/7 +basePath: /api/8 tags: - name: General Info - name: Processes @@ -374,7 +374,8 @@ paths: - Method DELETE summary: Reset statistics for an HTTP server zone description: Resets statistics of accepted and discarded requests, responses, - received and sent bytes in a particular HTTP server zone. + received and sent bytes, counters of SSL handshakes and session reuses + in a particular HTTP server zone. operationId: deleteHttpServerZoneStat responses: '204': @@ -1330,7 +1331,8 @@ paths: - Method DELETE summary: Reset statistics for a stream server zone description: Resets statistics of accepted and discarded connections, sessions, - received and sent bytes in a particular stream server zone. + received and sent bytes, counters of SSL handshakes and session reuses + in a particular stream server zone. operationId: deleteStreamServerZoneStat responses: '204': @@ -2148,12 +2150,12 @@ definitions: <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</a>. example: nginx: - version: 1.17.3 - build: nginx-plus-r19 + version: 1.21.6 + build: nginx-plus-r27 address: 206.251.255.64 generation: 6 - load_timestamp: 2019-10-01T11:15:44.467Z - timestamp: 2019-10-01T09:26:07.305Z + load_timestamp: 2022-06-28T11:15:44.467Z + timestamp: 2022-06-28T09:26:07.305Z pid: 32212 ppid: 32210 NginxProcesses: @@ -2393,6 +2395,10 @@ definitions: discarded: 2020 received: 180157219 sent: 20183175459 + ssl: + handshakes: 65432 + handshakes_failed: 421 + session_reuses: 4645 site2: processing: 1 requests: 185307 @@ -2411,6 +2417,10 @@ definitions: discarded: 20326 received: 51575327 sent: 2983241510 + ssl: + handshakes: 104303 + handshakes_failed: 1421 + session_reuses: 54645 NginxHTTPServerZone: title: HTTP Server Zone type: object @@ -2474,6 +2484,22 @@ definitions: sent: type: integer description: The total number of bytes sent to clients. + ssl: + type: object + readOnly: true + properties: + handshakes: + type: integer + description: The total number of successful SSL handshakes. + readOnly: true + handshakes_failed: + type: integer + description: The total number of failed SSL handshakes. + readOnly: true + session_reuses: + type: integer + description: The total number of session reuses during SSL handshake. + readOnly: true example: processing: 1 requests: 706690 @@ -2492,6 +2518,10 @@ definitions: discarded: 1513 received: 172711587 sent: 19415530115 + ssl: + handshakes: 104303 + handshakes_failed: 1421 + session_reuses: 54645 NginxHTTPLocationZonesMap: title: HTTP Location Zones description: | @@ -2901,6 +2931,10 @@ definitions: weight: 5 state: up active: 0 + ssl: + handshakes: 620311 + handshakes_failed: 3432 + session_reuses: 36442 requests: 667231 header_time: 20 response_time: 36 @@ -2925,8 +2959,8 @@ definitions: unhealthy: 0 last_passed: true downtime: 0 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z - id: 1 server: 10.0.0.1:8089 name: 10.0.0.1:8089 @@ -2953,8 +2987,8 @@ definitions: unhealthy: 1 last_passed: false downtime: 262925617 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z keepalive: 0 zombies: 0 zone: trac-backend @@ -2967,6 +3001,10 @@ definitions: weight: 5 state: up active: 0 + ssl: + handshakes: 620311 + handshakes_failed: 3432 + session_reuses: 36442 requests: 667231 header_time: 20 response_time: 36 @@ -2991,8 +3029,8 @@ definitions: unhealthy: 0 last_passed: true downtime: 0 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z - id: 1 server: 10.0.0.1:8089 name: 10.0.0.1:8089 @@ -3019,8 +3057,8 @@ definitions: unhealthy: 1 last_passed: false downtime: 262925617 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z keepalive: 0 zombies: 0 zone: hg-backend @@ -3071,6 +3109,10 @@ definitions: weight: 5 state: up active: 0 + ssl: + handshakes: 620311 + handshakes_failed: 3432 + session_reuses: 36442 max_conns: 20 requests: 667231 header_time: 20 @@ -3096,8 +3138,8 @@ definitions: unhealthy: 0 last_passed: true downtime: 0 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z - id: 1 server: 10.0.0.1:8089 name: 10.0.0.1:8089 @@ -3125,8 +3167,8 @@ definitions: unhealthy: 1 last_passed: false downtime: 262925617 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z keepalive: 0 zombies: 0 zone: upstream_backend @@ -3189,6 +3231,22 @@ definitions: type: integer description: The current number of active connections. readOnly: true + ssl: + type: object + readOnly: true + properties: + handshakes: + type: integer + description: The total number of successful SSL handshakes. + readOnly: true + handshakes_failed: + type: integer + description: The total number of failed SSL handshakes. + readOnly: true + session_reuses: + type: integer + description: The total number of session reuses during SSL handshake. + readOnly: true max_conns: type: integer description: The @@ -3496,6 +3554,10 @@ definitions: discarded: 0 received: 28988975 sent: 3879346317 + ssl: + handshakes: 76455 + handshakes_failed: 432 + session_reuses: 28770 dns: processing: 1 connections: 155569 @@ -3507,6 +3569,10 @@ definitions: discarded: 0 received: 4200363 sent: 20489184 + ssl: + handshakes: 2040 + handshakes_failed: 23 + session_reuses: 65 NginxStreamServerZone: title: Stream Server Zone type: object @@ -3552,6 +3618,22 @@ definitions: sent: type: integer description: The total number of bytes sent to clients. + ssl: + type: object + readOnly: true + properties: + handshakes: + type: integer + description: The total number of successful SSL handshakes. + readOnly: true + handshakes_failed: + type: integer + description: The total number of failed SSL handshakes. + readOnly: true + session_reuses: + type: integer + description: The total number of session reuses during SSL handshake. + readOnly: true example: dns: processing: 1 @@ -3564,6 +3646,10 @@ definitions: discarded: 0 received: 4200363 sent: 20489184 + ssl: + handshakes: 76455 + handshakes_failed: 432 + session_reuses: 28770 NginxStreamLimitConnZonesMap: title: Stream limit_conns description: | @@ -3608,6 +3694,10 @@ definitions: weight: 5 state: up active: 0 + ssl: + handshakes: 1045 + handshakes_failed: 89 + session_reuses: 321 max_conns: 30 connecions: 1231 sent: 251946292 @@ -3620,8 +3710,8 @@ definitions: unhealthy: 0 last_passed: true downtime: 0 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z - id: 1 server: 10.0.0.1:12346 name: 10.0.0.1:12346 @@ -3641,8 +3731,8 @@ definitions: unhealthy: 1 last_passed: false downtime: 262925617 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z zombies: 0 zone: mysql_backends dns: @@ -3654,6 +3744,10 @@ definitions: weight: 5 state: up active: 0 + ssl: + handshakes: 5268 + handshakes_failed: 121 + session_reuses: 854 max_conns: 30 connections: 667231 sent: 251946292 @@ -3666,8 +3760,8 @@ definitions: unhealthy: 0 last_passed: true downtime: 0 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z - id: 1 server: 10.0.0.1:12348 name: 10.0.0.1:12348 @@ -3687,8 +3781,8 @@ definitions: unhealthy: 1 last_passed: false downtime: 262925617 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z zombies: 0 zone: dns NginxStreamUpstream: @@ -3716,6 +3810,10 @@ definitions: weight: 5 state: up active: 0 + ssl: + handshakes: 200 + handshakes_failed: 4 + session_reuses: 189 max_conns: 50 connections: 667231 sent: 251946292 @@ -3728,8 +3826,8 @@ definitions: unhealthy: 0 last_passed: true downtime: 0 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z - id: 1 server: 10.0.0.1:12348 name: 10.0.0.1:12348 @@ -3749,8 +3847,8 @@ definitions: unhealthy: 1 last_passed: false downtime: 262925617 - downstart: 2019-10-01T11:09:21.602Z - selected: 2019-10-01T15:01:25Z + downstart: 2022-06-28T11:09:21.602Z + selected: 2022-06-28T15:01:25Z zombies: 0 zone: dns NginxStreamUpstreamPeerMap: @@ -3811,6 +3909,22 @@ definitions: type: integer description: The current number of connections. readOnly: true + ssl: + type: object + readOnly: true + properties: + handshakes: + type: integer + description: The total number of successful SSL handshakes. + readOnly: true + handshakes_failed: + type: integer + description: The total number of failed SSL handshakes. + readOnly: true + session_reuses: + type: integer + description: The total number of session reuses during SSL handshake. + readOnly: true max_conns: type: integer description: The