Mercurial > hg > nginx-site

comparison yaml/nginx_api.yaml @ 2253:a89093ff86a3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clarified ISO 8601 time, changed example, bumped version in API.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 09 Oct 2018 12:28:06 +0300
parents 45a2b90247ad
children bb7e58ea3559
comparison
equal deleted inserted replaced
2252:5a740d0f7a77 2253:a89093ff86a3
1 swagger: '2.0' 1 swagger: '2.0'
2 info: 2 info:
3 version: '2.0' 3 version: '3.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
1530 <a href="https://nginx.org/en/docs/control.html#reconfiguration">reloads</a>. 1530 <a href="https://nginx.org/en/docs/control.html#reconfiguration">reloads</a>.
1531 load_timestamp: 1531 load_timestamp:
1532 type: string 1532 type: string
1533 format: date-time 1533 format: date-time
1534 description: Time of the last reload of configuration, 1534 description: Time of the last reload of configuration,
1535 in milliseconds since Epoch. 1535 in the ISO 8601 format with millisecond resolution.
1536 timestamp: 1536 timestamp:
1537 type: string 1537 type: string
1538 format: date-time 1538 format: date-time
1539 description: Current time in milliseconds since Epoch. 1539 description: Current time
1540 in the ISO 8601 format with millisecond resolution.
1540 pid: 1541 pid:
1541 type: integer 1542 type: integer
1542 description: The ID of the worker process that handled status request. 1543 description: The ID of the worker process that handled status request.
1543 ppid: 1544 ppid:
1544 type: integer 1545 type: integer
1545 description: The ID of the master process that started the 1546 description: The ID of the master process that started the
1546 <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</a>. 1547 <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</a>.
1547 example: 1548 example:
1548 nginx: 1549 nginx:
1549 version: 1.13.3 1550 version: 1.15.2
1550 build: nginx-plus-r12-p3 1551 build: nginx-plus-r16
1551 address: 206.251.255.64 1552 address: 206.251.255.64
1552 generation: 2 1553 generation: 6
1553 load_timestamp: 2017-07-07T11:09:21.594Z 1554 load_timestamp: 2018-10-08T09:05:48.776Z
1554 timestamp: 2017-07-11T09:31:13.477Z 1555 timestamp: 2018-10-08T15:23:17.056Z
1555 pid: 32212 1556 pid: 32212
1556 ppid: 32210 1557 ppid: 32210
1557 NginxProcesses: 1558 NginxProcesses:
1558 title: Processes 1559 title: Processes
1559 type: object 1560 type: object
2448 “<code>checking</code>”, and “<code>unhealthy</code>” states. 2449 “<code>checking</code>”, and “<code>unhealthy</code>” states.
2449 downstart: 2450 downstart:
2450 type: string 2451 type: string
2451 format: date-time 2452 format: date-time
2452 readOnly: true 2453 readOnly: true
2453 description: The time (in milliseconds since Epoch) when the server became 2454 description: The time when the server became
2454 “<code>unavail</code>”, “<code>checking</code>”, 2455 “<code>unavail</code>”, “<code>checking</code>”,
2455 or “<code>unhealthy</code>”. 2456 or “<code>unhealthy</code>”,
2457 in the ISO 8601 format with millisecond resolution.
2456 selected: 2458 selected:
2457 type: string 2459 type: string
2458 format: date-time 2460 format: date-time
2459 readOnly: true 2461 readOnly: true
2460 description: The time (in milliseconds since Epoch) 2462 description: The time when the server was last selected to process a request,
2461 when the server was last selected to process a request. 2463 in the ISO 8601 format with millisecond resolution.
2462 header_time: 2464 header_time:
2463 type: integer 2465 type: integer
2464 readOnly: true 2466 readOnly: true
2465 description: The average time to get the 2467 description: The average time to get the
2466 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_header_time">response header</a> 2468 <a href="https://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_header_time">response header</a>
3007 and “<code>unhealthy</code>” states. 3009 and “<code>unhealthy</code>” states.
3008 readOnly: true 3010 readOnly: true
3009 downstart: 3011 downstart:
3010 type: string 3012 type: string
3011 format: date-time 3013 format: date-time
3012 description: The time (in milliseconds since Epoch) when the server became 3014 description: The time when the server became
3013 “<code>unavail</code>”, “<code>checking</code>”, 3015 “<code>unavail</code>”, “<code>checking</code>”,
3014 or “<code>unhealthy</code>”. 3016 or “<code>unhealthy</code>”,
3017 in the ISO 8601 format with millisecond resolution.
3015 readOnly: true 3018 readOnly: true
3016 selected: 3019 selected:
3017 type: string 3020 type: string
3018 format: date-time 3021 format: date-time
3019 description: The time (in milliseconds since Epoch) 3022 description: The time when the server was last selected
3020 when the server was last selected to process a connection. 3023 to process a connection,
3024 in the ISO 8601 format with millisecond resolution.
3021 readOnly: true 3025 readOnly: true
3022 NginxStreamUpstreamConfServerMap: 3026 NginxStreamUpstreamConfServerMap:
3023 title: Stream Upstream Servers 3027 title: Stream Upstream Servers
3024 description: | 3028 description: |
3025 An array of stream upstream servers for dynamic configuration. 3029 An array of stream upstream servers for dynamic configuration.