Mercurial > hg > nginx-site

comparison yaml/nginx_api.yaml @ 2992:6e094f915896

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 15 Aug 2023 12:36:26 +0100
parents a85e4d126bc7
children
comparison
equal deleted inserted replaced
2991:1f672755959a 2992:6e094f915896
1 swagger: '2.0' 1 swagger: '2.0'
2 info: 2 info:
3 version: '8.0' 3 version: '9.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/8 12 basePath: /api/9
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: Workers
17 - name: Slabs 18 - name: Slabs
18 - name: Resolvers 19 - name: Resolvers
19 - name: SSL 20 - name: SSL
20 - name: HTTP 21 - name: HTTP
21 - name: HTTP Requests 22 - name: HTTP Requests
2093 responses: 2094 responses:
2094 '204': 2095 '204':
2095 description: Success 2096 description: Success
2096 '404': 2097 '404':
2097 description: Unknown version (*UnknownVersion*) 2098 description: Unknown version (*UnknownVersion*)
2099 schema:
2100 $ref: '#/definitions/NginxError'
2101 '405':
2102 description: Method disabled (*MethodDisabled*)
2103 schema:
2104 $ref: '#/definitions/NginxError'
2105 /workers/:
2106 get:
2107 tags:
2108 - Workers
2109 - Method GET
2110 summary: Return statistics for all worker processes
2111 description: Returns statistics for all worker processes such as accepted, dropped, active, idle connections, total and current requests.
2112 operationId: getWorkers
2113 produces:
2114 - application/json
2115 parameters:
2116 - in: query
2117 name: fields
2118 type: string
2119 description: Limits which fields of worker process statistics will be output.
2120 responses:
2121 '200':
2122 description: Success
2123 schema:
2124 $ref: '#/definitions/NginxWorkersMap'
2125 '404':
2126 description: |
2127 Worker not found (*WorkerNotFound*),
2128 unknown version (*UnknownVersion*)
2129 schema:
2130 $ref: '#/definitions/NginxError'
2131 delete:
2132 tags:
2133 - Workers
2134 - Method DELETE
2135 summary: Reset statistics for all worker processes.
2136 description: |
2137 Resets statistics for all worker processes such as
2138 accepted, dropped, active, idle connections, total and current requests.
2139 operationId: deleteWorkersStat
2140 produces:
2141 - application/json
2142 responses:
2143 '204':
2144 description: Success
2145 '404':
2146 description: |
2147 Worker not found (*WorkerNotFound*),
2148 unknown version (*UnknownVersion*)
2149 schema:
2150 $ref: '#/definitions/NginxError'
2151 '405':
2152 description: Method disabled (*MethodDisabled*)
2153 schema:
2154 $ref: '#/definitions/NginxError'
2155 '/workers/{workerId}':
2156 parameters:
2157 - name: workerId
2158 in: path
2159 description: The ID of the worker process.
2160 required: true
2161 type: string
2162 get:
2163 tags:
2164 - Workers
2165 - Method GET
2166 summary: Return status of a worker process
2167 description: Returns status of a particular worker process.
2168 operationId: getWorker
2169 produces:
2170 - application/json
2171 parameters:
2172 - in: query
2173 name: fields
2174 type: string
2175 description: Limits which fields of worker process statistics will be output.
2176 responses:
2177 '200':
2178 description: Success
2179 schema:
2180 $ref: '#/definitions/NginxWorker'
2181 '404':
2182 description: |
2183 Worker not found (*WorkerNotFound*),
2184 unknown version (*UnknownVersion*)
2185 schema:
2186 $ref: '#/definitions/NginxError'
2187 delete:
2188 tags:
2189 - Workers
2190 - Method DELETE
2191 summary: Reset statistics for a worker process.
2192 description: |
2193 Resets statistics of accepted, dropped, active, idle connections,
2194 as well as total and current requests.
2195 operationId: deleteWorkerStat
2196 produces:
2197 - application/json
2198 responses:
2199 '204':
2200 description: Success
2201 '404':
2202 description: |
2203 Worker not found (*WorkerNotFound*),
2204 unknown version (*UnknownVersion*)
2098 schema: 2205 schema:
2099 $ref: '#/definitions/NginxError' 2206 $ref: '#/definitions/NginxError'
2100 '405': 2207 '405':
2101 description: Method disabled (*MethodDisabled*) 2208 description: Method disabled (*MethodDisabled*)
2102 schema: 2209 schema:
4620 nxdomain: 0 4727 nxdomain: 0
4621 notimp: 0 4728 notimp: 0
4622 refused: 0 4729 refused: 0
4623 timedout: 243 4730 timedout: 243
4624 unknown: 478 4731 unknown: 478
4732 NginxWorker:
4733 title: Worker process
4734 description: |
4735 Statistics per each worker process.
4736 properties:
4737 id:
4738 type: integer
4739 description: The ID of the worker process.
4740 pid:
4741 type: integer
4742 description: The PID identifier of the worker process used by the operating system.
4743 connections:
4744 type: object
4745 description: |
4746 The number of accepted, dropped, active, and idle connections
4747 per worker process.
4748 properties:
4749 accepted:
4750 type: integer
4751 description: |
4752 The total number of client connections
4753 accepted by the worker process.
4754 dropped:
4755 type: integer
4756 description: |
4757 The total number of client connections
4758 dropped by the worker process.
4759 active:
4760 type: integer
4761 description: |
4762 The current number of active client connections
4763 that are currently being handled by the worker process.
4764 idle:
4765 type: integer
4766 description: |
4767 The number of idle client connections
4768 that are currently being handled by the worker process.
4769 http:
4770 type: object
4771 properties:
4772 requests:
4773 type: object
4774 description: The total number of client requests handled by the worker process.
4775 properties:
4776 total:
4777 type: integer
4778 description: The total number of client requests received by the worker process.
4779 current:
4780 type: integer
4781 description: The current number of client requests that are currently being processed by the worker process.
4782 example:
4783 id: 0
4784 pid: 32212
4785 connections:
4786 accepted: 1
4787 dropped: 0
4788 active: 1
4789 idle: 0
4790 http:
4791 requests:
4792 total: 15
4793 current: 1
4794 NginxWorkersMap:
4795 title: Worker processes
4796 description: nginx worker processes object.
4797 type: object
4798 additionalProperties:
4799 $ref: '#/definitions/NginxWorker'
4800 example:
4801 - id: 0
4802 pid: 32212
4803 connections:
4804 accepted: 1
4805 dropped: 0
4806 active: 1
4807 idle: 0
4808 http:
4809 requests:
4810 total: 19
4811 current: 1
4812 - id: 1
4813 pid: 32214
4814 connections:
4815 accepted: 1
4816 dropped: 0
4817 active: 1
4818 idle: 0
4819 http:
4820 requests:
4821 total: 15
4822 current: 0
4625 NginxError: 4823 NginxError:
4626 title: Error 4824 title: Error
4627 description: | 4825 description: |
4628 nginx error object. 4826 nginx error object.
4629 type: object 4827 type: object