# HG changeset patch # User Ruslan Ermilov # Date 1575282185 -10800 # Node ID 98fd810c13e0ef503da10545575eb3f3ea33dae5 # Parent 409e1f755037e60bb0978530e100f972484daac5 Updated docs for the upcoming NGINX Plus release. diff -r 409e1f755037 -r 98fd810c13e0 xml/en/docs/http/ngx_http_api_module.xml --- a/xml/en/docs/http/ngx_http_api_module.xml Wed Nov 27 17:09:36 2019 +0300 +++ b/xml/en/docs/http/ngx_http_api_module.xml Mon Dec 02 13:23:05 2019 +0300 @@ -101,21 +101,21 @@ a supported API version in the URI. Examples of API requests with this configuration: -http://127.0.0.1/api/5/ -http://127.0.0.1/api/5/nginx -http://127.0.0.1/api/5/connections -http://127.0.0.1/api/5/http/requests -http://127.0.0.1/api/5/http/server_zones/server_backend -http://127.0.0.1/api/5/http/caches/cache_backend -http://127.0.0.1/api/5/http/upstreams/backend -http://127.0.0.1/api/5/http/upstreams/backend/servers/ -http://127.0.0.1/api/5/http/upstreams/backend/servers/1 -http://127.0.0.1/api/5/http/keyvals/one?key=arg1 -http://127.0.0.1/api/5/stream/ -http://127.0.0.1/api/5/stream/server_zones/server_backend -http://127.0.0.1/api/5/stream/upstreams/ -http://127.0.0.1/api/5/stream/upstreams/backend -http://127.0.0.1/api/5/stream/upstreams/backend/servers/1 +http://127.0.0.1/api/6/ +http://127.0.0.1/api/6/nginx +http://127.0.0.1/api/6/connections +http://127.0.0.1/api/6/http/requests +http://127.0.0.1/api/6/http/server_zones/server_backend +http://127.0.0.1/api/6/http/caches/cache_backend +http://127.0.0.1/api/6/http/upstreams/backend +http://127.0.0.1/api/6/http/upstreams/backend/servers/ +http://127.0.0.1/api/6/http/upstreams/backend/servers/1 +http://127.0.0.1/api/6/http/keyvals/one?key=arg1 +http://127.0.0.1/api/6/stream/ +http://127.0.0.1/api/6/stream/server_zones/server_backend +http://127.0.0.1/api/6/stream/upstreams/ +http://127.0.0.1/api/6/stream/upstreams/backend +http://127.0.0.1/api/6/stream/upstreams/backend/servers/1 @@ -146,14 +146,14 @@ All API requests should contain a supported API version in the URI. If the request URI equals the location prefix, the list of supported API versions is returned. -The current API version is “5”. +The current API version is “6”. The optional “fields” argument in the request line specifies which fields of the requested objects will be output: -http://127.0.0.1/api/5/nginx?fields=version,build +http://127.0.0.1/api/6/nginx?fields=version,build @@ -199,6 +199,21 @@ +The /stream/limit_conns/ data +were added in version 6. + + + +The /http/limit_conns/ data +were added in version 6. + + + +The /http/limit_reqs/ data +were added in version 6. + + + The “expire” parameter of a key-value pair can be set or @@ -708,6 +723,154 @@ + +/http/limit_conns/ + + +Supported methods: + + +GET - Return status of all HTTP limit_conn zones +Returns status information for each HTTP limit_conn zone. + +Request parameters: + +fields +(string, optional) + +Limits which fields of limit_conn zones will be output. If the “fields” value is empty, then only zone names will be output. + + + +Possible responses: + + +200 - Success, returns a collection of "HTTP Connections Limiting" objects for all HTTP limit conns + + + + + +/http/limit_conns/{httpLimitConnZoneName} + + +Parameters common for all methods: + +httpLimitConnZoneName +(string, required) + +The name of a limit_conn zone. + +Supported methods: + + +GET - Return status of an HTTP limit_conn zone +Returns status of a particular HTTP limit_conn zone. + +Request parameters: + +fields +(string, optional) + +Limits which fields of the limit_conn zone will be output. + + + +Possible responses: + + +200 - Success, returns HTTP Connections Limiting +404 - limit_conn not found (LimitConnNotFound), returns Error + + + +DELETE - Reset statistics for an HTTP limit_conn zone +Resets the connection limiting statistics. + +Possible responses: + + +204 - Success +404 - limit_conn not found (LimitConnNotFound), returns Error +405 - Method disabled (MethodDisabled), returns Error + + + + + +/http/limit_reqs/ + + +Supported methods: + + +GET - Return status of all HTTP limit_req zones +Returns status information for each HTTP limit_req zone. + +Request parameters: + +fields +(string, optional) + +Limits which fields of limit_req zones will be output. If the “fields” value is empty, then only zone names will be output. + + + +Possible responses: + + +200 - Success, returns a collection of "HTTP Requests Rate Limiting" objects for all HTTP limit reqs + + + + + +/http/limit_reqs/{httpLimitReqZoneName} + + +Parameters common for all methods: + +httpLimitReqZoneName +(string, required) + +The name of a limit_req zone. + +Supported methods: + + +GET - Return status of an HTTP limit_req zone +Returns status of a particular HTTP limit_req zone. + +Request parameters: + +fields +(string, optional) + +Limits which fields of the limit_req zone will be output. + + + +Possible responses: + + +200 - Success, returns HTTP Requests Rate Limiting +404 - limit_req not found (LimitReqNotFound), returns Error + + + +DELETE - Reset statistics for an HTTP limit_req zone +Resets the requests limiting statistics. + +Possible responses: + + +204 - Success +404 - limit_req not found (LimitReqNotFound), returns Error +405 - Method disabled (MethodDisabled), returns Error + + + + /http/upstreams/ @@ -1162,6 +1325,80 @@ + +/stream/limit_conns/ + + +Supported methods: + + +GET - Return status of all stream limit_conn zones +Returns status information for each stream limit_conn zone. + +Request parameters: + +fields +(string, optional) + +Limits which fields of limit_conn zones will be output. If the “fields” value is empty, then only zone names will be output. + + + +Possible responses: + + +200 - Success, returns a collection of "Stream Connections Limiting" objects for all stream limit conns + + + + + +/stream/limit_conns/{streamLimitConnZoneName} + + +Parameters common for all methods: + +streamLimitConnZoneName +(string, required) + +The name of a limit_conn zone. + +Supported methods: + + +GET - Return status of an stream limit_conn zone +Returns status of a particular stream limit_conn zone. + +Request parameters: + +fields +(string, optional) + +Limits which fields of the limit_conn zone will be output. + + + +Possible responses: + + +200 - Success, returns Stream Connections Limiting +404 - limit_conn not found (LimitConnNotFound), returns Error + + + +DELETE - Reset statistics for a stream limit_conn zone +Resets the connection limiting statistics. + +Possible responses: + + +204 - Success +404 - limit_conn not found (LimitConnNotFound), returns Error +405 - Method disabled (MethodDisabled), returns Error + + + + /stream/upstreams/ @@ -2340,6 +2577,80 @@ } } + +HTTP Connections Limiting: + + +passed (integer) + + +The total number of connections that were neither limited nor accounted as limited. + + +rejected (integer) + + +The total number of connections that were rejected. + + +rejected_dry_run (integer) + + +The total number of connections accounted as rejected in the dry run mode. + + +Example: + +{ + "passed" : 15, + "rejected" : 0, + "rejected_dry_run" : 2 +} + + +HTTP Requests Rate Limiting: + + +passed (integer) + + +The total number of requests that were neither limited nor accounted as limited. + + +delayed (integer) + + +The total number of requests that were delayed. + + +rejected (integer) + + +The total number of requests that were rejected. + + +delayed_dry_run (integer) + + +The total number of requests accounted as delayed in the dry run mode. + + +rejected_dry_run (integer) + + +The total number of requests accounted as rejected in the dry run mode. + + +Example: + +{ + "passed" : 15, + "delayed" : 4, + "rejected" : 0, + "delayed_dry_run" : 1, + "rejected_dry_run" : 2 +} + HTTP Upstream: @@ -2867,6 +3178,36 @@ } } + +Stream Connections Limiting: + + +passed (integer) + + +The total number of connections that were neither limited nor accounted as limited. + + +rejected (integer) + + +The total number of connections that were rejected. + + +rejected_dry_run (integer) + + +The total number of connections accounted as rejected in the dry run mode. + + +Example: + +{ + "passed" : 15, + "rejected" : 0, + "rejected_dry_run" : 2 +} + Stream Upstream: diff -r 409e1f755037 -r 98fd810c13e0 xml/en/docs/http/ngx_http_api_module_head.xml --- a/xml/en/docs/http/ngx_http_api_module_head.xml Wed Nov 27 17:09:36 2019 +0300 +++ b/xml/en/docs/http/ngx_http_api_module_head.xml Mon Dec 02 13:23:05 2019 +0300 @@ -101,21 +101,21 @@ a supported API version in the URI. Examples of API requests with this configuration: -http://127.0.0.1/api/5/ -http://127.0.0.1/api/5/nginx -http://127.0.0.1/api/5/connections -http://127.0.0.1/api/5/http/requests -http://127.0.0.1/api/5/http/server_zones/server_backend -http://127.0.0.1/api/5/http/caches/cache_backend -http://127.0.0.1/api/5/http/upstreams/backend -http://127.0.0.1/api/5/http/upstreams/backend/servers/ -http://127.0.0.1/api/5/http/upstreams/backend/servers/1 -http://127.0.0.1/api/5/http/keyvals/one?key=arg1 -http://127.0.0.1/api/5/stream/ -http://127.0.0.1/api/5/stream/server_zones/server_backend -http://127.0.0.1/api/5/stream/upstreams/ -http://127.0.0.1/api/5/stream/upstreams/backend -http://127.0.0.1/api/5/stream/upstreams/backend/servers/1 +http://127.0.0.1/api/6/ +http://127.0.0.1/api/6/nginx +http://127.0.0.1/api/6/connections +http://127.0.0.1/api/6/http/requests +http://127.0.0.1/api/6/http/server_zones/server_backend +http://127.0.0.1/api/6/http/caches/cache_backend +http://127.0.0.1/api/6/http/upstreams/backend +http://127.0.0.1/api/6/http/upstreams/backend/servers/ +http://127.0.0.1/api/6/http/upstreams/backend/servers/1 +http://127.0.0.1/api/6/http/keyvals/one?key=arg1 +http://127.0.0.1/api/6/stream/ +http://127.0.0.1/api/6/stream/server_zones/server_backend +http://127.0.0.1/api/6/stream/upstreams/ +http://127.0.0.1/api/6/stream/upstreams/backend +http://127.0.0.1/api/6/stream/upstreams/backend/servers/1 @@ -146,14 +146,14 @@ All API requests should contain a supported API version in the URI. If the request URI equals the location prefix, the list of supported API versions is returned. -The current API version is “5”. +The current API version is “6”. The optional “fields” argument in the request line specifies which fields of the requested objects will be output: -http://127.0.0.1/api/5/nginx?fields=version,build +http://127.0.0.1/api/6/nginx?fields=version,build @@ -199,6 +199,21 @@ +The /stream/limit_conns/ data +were added in version 6. + + + +The /http/limit_conns/ data +were added in version 6. + + + +The /http/limit_reqs/ data +were added in version 6. + + + The “expire” parameter of a key-value pair can be set or diff -r 409e1f755037 -r 98fd810c13e0 xml/en/docs/http/ngx_http_keyval_module.xml --- a/xml/en/docs/http/ngx_http_keyval_module.xml Wed Nov 27 17:09:36 2019 +0300 +++ b/xml/en/docs/http/ngx_http_keyval_module.xml Mon Dec 02 13:23:05 2019 +0300 @@ -9,7 +9,7 @@ + rev="8">
@@ -86,7 +86,7 @@ zone=name:size [state=file] [timeout=time] - [type=string|ip] + [type=string|ip|prefix] [sync] http @@ -136,6 +136,13 @@ specified by a record key or exactly match an IP address +type=prefix + +variable lookup is performed using prefix match +of a record key and a search key (1.17.5); +to match a record key, the record key must be a prefix of the search key + + diff -r 409e1f755037 -r 98fd810c13e0 xml/en/docs/http/ngx_http_upstream_module.xml --- a/xml/en/docs/http/ngx_http_upstream_module.xml Wed Nov 27 17:09:36 2019 +0300 +++ b/xml/en/docs/http/ngx_http_upstream_module.xml Mon Dec 02 13:23:05 2019 +0300 @@ -10,7 +10,7 @@ + rev="83">
@@ -885,6 +885,87 @@ + + + address ... + [valid=time] + [ipv6=on|off] + [status_zone=zone] + +upstream +1.17.5 + + +Configures name servers used to resolve names of upstream servers +into addresses, for example: + +resolver 127.0.0.1 [::1]:5353; + +The address can be specified as a domain name or IP address, +with an optional port. +If port is not specified, the port 53 is used. +Name servers are queried in a round-robin fashion. + + + +By default, nginx will look up both IPv4 and IPv6 addresses while resolving. +If looking up of IPv6 addresses is not desired, +the ipv6=off parameter can be specified. + + + +By default, nginx caches answers using the TTL value of a response. +An optional valid parameter allows overriding it: + +resolver 127.0.0.1 [::1]:5353 valid=30s; + + +To prevent DNS spoofing, it is recommended +configuring DNS servers in a properly secured trusted local network. + + + + +The optional status_zone parameter +enables +collection +of DNS server statistics of requests and responses +in the specified zone. + + + + +This directive is available as part of our +commercial subscription. + + + + + + + +time +30s +upstream +1.17.5 + + +Sets a timeout for name resolution, for example: + +resolver_timeout 5s; + + + + + +This directive is available as part of our +commercial subscription. + + + + + + cookie name diff -r 409e1f755037 -r 98fd810c13e0 xml/en/docs/stream/ngx_stream_keyval_module.xml --- a/xml/en/docs/stream/ngx_stream_keyval_module.xml Wed Nov 27 17:09:36 2019 +0300 +++ b/xml/en/docs/stream/ngx_stream_keyval_module.xml Mon Dec 02 13:23:05 2019 +0300 @@ -9,7 +9,7 @@ + rev="7">
@@ -90,7 +90,7 @@ zone=name:size [state=file] [timeout=time] - [type=string|ip] + [type=string|ip|prefix] [sync] stream @@ -140,6 +140,13 @@ specified by a record key or exactly match an IP address +type=prefix + +variable lookup is performed using prefix match +of a record key and a search key (1.17.5); +to match a record key, the record key must be a prefix of the search key + + diff -r 409e1f755037 -r 98fd810c13e0 xml/en/docs/stream/ngx_stream_upstream_module.xml --- a/xml/en/docs/stream/ngx_stream_upstream_module.xml Wed Nov 27 17:09:36 2019 +0300 +++ b/xml/en/docs/stream/ngx_stream_upstream_module.xml Mon Dec 02 13:23:05 2019 +0300 @@ -9,7 +9,7 @@ + rev="38">
@@ -549,6 +549,87 @@ + + + + address ... + [valid=time] + [ipv6=on|off] + [status_zone=zone] + +upstream +1.17.5 + + +Configures name servers used to resolve names of upstream servers +into addresses, for example: + +resolver 127.0.0.1 [::1]:5353; + +The address can be specified as a domain name or IP address, +with an optional port. +If port is not specified, the port 53 is used. +Name servers are queried in a round-robin fashion. + + + +By default, nginx will look up both IPv4 and IPv6 addresses while resolving. +If looking up of IPv6 addresses is not desired, +the ipv6=off parameter can be specified. + + + +By default, nginx caches answers using the TTL value of a response. +The optional valid parameter allows overriding it: + +resolver 127.0.0.1 [::1]:5353 valid=30s; + + +To prevent DNS spoofing, it is recommended +configuring DNS servers in a properly secured trusted local network. + + + + +The optional status_zone parameter +enables +collection +of DNS server statistics of requests and responses +in the specified zone. + + + + +This directive is available as part of our +commercial subscription. + + + + + + + +time +30s +upstream +1.17.5 + + +Sets a timeout for name resolution, for example: + +resolver_timeout 5s; + + + + + +This directive is available as part of our +commercial subscription. + + + + +
diff -r 409e1f755037 -r 98fd810c13e0 xml/ru/docs/http/ngx_http_upstream_module.xml --- a/xml/ru/docs/http/ngx_http_upstream_module.xml Wed Nov 27 17:09:36 2019 +0300 +++ b/xml/ru/docs/http/ngx_http_upstream_module.xml Mon Dec 02 13:23:05 2019 +0300 @@ -10,7 +10,7 @@ + rev="83">
@@ -893,6 +893,89 @@ + + + адрес ... + [valid=время] + [ipv6=on|off] + [status_zone=зона] + +upstream +1.17.5 + + +Задаёт серверы DNS, используемые для преобразования имён вышестоящих серверов +в адреса, например: + +resolver 127.0.0.1 [::1]:5353; + +Адрес может быть указан в виде доменного имени или IP-адреса, +и необязательного порта. +Если порт не указан, используется порт 53. +Серверы DNS опрашиваются циклически. + + + +По умолчанию nginx будет искать как IPv4-, так и IPv6-адреса +при преобразовании имён в адреса. +Если поиск IPv6-адресов нежелателен, +можно указать параметр ipv6=off. + + + +По умолчанию nginx кэширует ответы, используя значение TTL из ответа. +Необязательный параметр valid позволяет это +переопределить: + +resolver 127.0.0.1 [::1]:5353 valid=30s; + + +Для предотвращения DNS-спуфинга рекомендуется +использовать DNS-серверы в защищённой доверенной локальной сети. + + + + +Необязательный параметр status_zone +включает +сбор информации +о запросах и ответах сервера DNS +в указанной зоне. + + + + +Эта директива доступна как часть +коммерческой подписки. + + + + + + + +время +30s +upstream +1.17.5 + + +Задаёт таймаут для преобразования имени в адрес, например: + +resolver_timeout 5s; + + + + + +Эта директива доступна как часть +коммерческой подписки. + + + + + + cookie имя diff -r 409e1f755037 -r 98fd810c13e0 xml/ru/docs/stream/ngx_stream_upstream_module.xml --- a/xml/ru/docs/stream/ngx_stream_upstream_module.xml Wed Nov 27 17:09:36 2019 +0300 +++ b/xml/ru/docs/stream/ngx_stream_upstream_module.xml Mon Dec 02 13:23:05 2019 +0300 @@ -9,7 +9,7 @@ + rev="38">
@@ -550,6 +550,89 @@ + + + + адрес ... + [valid=время] + [ipv6=on|off] + [status_zone=зона] + +upstream +1.17.5 + + +Задаёт серверы DNS, используемые для преобразования имён вышестоящих серверов +в адреса, например: + +resolver 127.0.0.1 [::1]:5353; + +Адрес может быть указан в виде доменного имени или IP-адреса, +и необязательного порта. +Если порт не указан, используется порт 53. +Серверы DNS опрашиваются циклически. + + + +По умолчанию nginx будет искать как IPv4-, так и IPv6-адреса +при преобразовании имён в адреса. +Если поиск IPv6-адресов нежелателен, +можно указать параметр ipv6=off. + + + +По умолчанию nginx кэширует ответы, используя значение TTL из ответа. +Необязательный параметр valid позволяет это +переопределить: + +resolver 127.0.0.1 [::1]:5353 valid=30s; + + +Для предотвращения DNS-спуфинга рекомендуется +использовать DNS-серверы в защищённой доверенной локальной сети. + + + + +Необязательный параметр status_zone +включает +сбор информации +о запросах и ответах сервера DNS +в указанной зоне. + + + + +Эта директива доступна как часть +коммерческой подписки. + + + + + + + +время +30s +upstream +1.17.5 + + +Задаёт таймаут для преобразования имени в адрес, например: + +resolver_timeout 5s; + + + + + +Эта директива доступна как часть +коммерческой подписки. + + + + +
diff -r 409e1f755037 -r 98fd810c13e0 yaml/nginx_api.yaml --- a/yaml/nginx_api.yaml Wed Nov 27 17:09:36 2019 +0300 +++ b/yaml/nginx_api.yaml Mon Dec 02 13:23:05 2019 +0300 @@ -1,6 +1,6 @@ swagger: '2.0' info: - version: '5.0' + version: '6.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 @@ 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/5 +basePath: /api/6 tags: - name: General Info - name: Processes @@ -22,10 +22,13 @@ - name: HTTP Server Zones - name: HTTP Location Zones - name: HTTP Caches + - name: HTTP Limit Conns + - name: HTTP Limit Reqs - name: HTTP Keyvals - name: HTTP Upstreams - name: Stream - name: Stream Server Zones + - name: Stream Limit Conns - name: Stream Keyvals - name: Stream Upstreams - name: Stream Zone Sync @@ -470,6 +473,156 @@ description: Method disabled (*MethodDisabled*) schema: $ref: '#/definitions/NginxError' + /http/limit_conns/: + get: + tags: + - HTTP Limit Conns + - Method GET + summary: Return status of all HTTP limit_conn zones + description: Returns status information for each HTTP + [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone). + operationId: getHttpLimitConnZones + produces: + - application/json + parameters: + - in: query + name: fields + type: string + description: Limits which fields of limit_conn zones will be output. + If the “fields” value is empty, + then only zone names will be output. + responses: + '200': + description: Success + schema: + $ref: '#/definitions/NginxHTTPLimitConnZonesMap' + '/http/limit_conns/{httpLimitConnZoneName}': + parameters: + - name: httpLimitConnZoneName + in: path + description: The name of a + [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone). + type: string + required: true + get: + tags: + - HTTP Limit Conns + - Method GET + summary: Return status of an HTTP limit_conn zone + description: Returns status of a particular HTTP + [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone). + operationId: getHttpLimitConnZone + produces: + - application/json + parameters: + - name: fields + in: query + type: string + description: Limits which fields of the + [limit_conn zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone) + will be output. + responses: + '200': + description: Success + schema: + $ref: '#/definitions/NginxHTTPLimitConnZone' + '404': + description: limit_conn not found (*LimitConnNotFound*) + schema: + $ref: '#/definitions/NginxError' + delete: + tags: + - HTTP Limit Conns + - Method DELETE + summary: Reset statistics for an HTTP limit_conn zone + description: Resets the connection limiting statistics. + operationId: deleteHttpLimitConnZoneStat + responses: + '204': + description: Success + '404': + description: limit_conn not found (*LimitConnNotFound*) + schema: + $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' + /http/limit_reqs/: + get: + tags: + - HTTP Limit Reqs + - Method GET + summary: Return status of all HTTP limit_req zones + description: Returns status information for each HTTP + [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone). + operationId: getHttpLimitReqZones + produces: + - application/json + parameters: + - in: query + name: fields + type: string + description: Limits which fields of limit_req zones will be output. + If the “fields” value is empty, + then only zone names will be output. + responses: + '200': + description: Success + schema: + $ref: '#/definitions/NginxHTTPLimitReqZonesMap' + '/http/limit_reqs/{httpLimitReqZoneName}': + parameters: + - name: httpLimitReqZoneName + in: path + description: The name of a + [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone). + type: string + required: true + get: + tags: + - HTTP Limit Reqs + - Method GET + summary: Return status of an HTTP limit_req zone + description: Returns status of a particular HTTP + [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone). + operationId: getHttpLimitReqZone + produces: + - application/json + parameters: + - name: fields + in: query + type: string + description: Limits which fields of the + [limit_req zone](https://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone) + will be output. + responses: + '200': + description: Success + schema: + $ref: '#/definitions/NginxHTTPLimitReqZone' + '404': + description: limit_req not found (*LimitReqNotFound*) + schema: + $ref: '#/definitions/NginxError' + delete: + tags: + - HTTP Limit Reqs + - Method DELETE + summary: Reset statistics for an HTTP limit_req zone + description: Resets the requests limiting statistics. + operationId: deleteHttpLimitReqZoneStat + responses: + '204': + description: Success + '404': + description: limit_req not found (*LimitReqNotFound*) + schema: + $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' /http/upstreams/: get: tags: @@ -1046,6 +1199,81 @@ description: Method disabled (*MethodDisabled*) schema: $ref: '#/definitions/NginxError' + /stream/limit_conns/: + get: + tags: + - Stream Limit Conns + - Method GET + summary: Return status of all stream limit_conn zones + description: Returns status information for each stream + [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone). + operationId: getStreamLimitConnZones + produces: + - application/json + parameters: + - in: query + name: fields + type: string + description: Limits which fields of limit_conn zones will be output. + If the “fields” value is empty, + then only zone names will be output. + responses: + '200': + description: Success + schema: + $ref: '#/definitions/NginxStreamLimitConnZonesMap' + '/stream/limit_conns/{streamLimitConnZoneName}': + parameters: + - name: streamLimitConnZoneName + in: path + description: The name of a + [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone). + type: string + required: true + get: + tags: + - Stream Limit Conns + - Method GET + summary: Return status of an stream limit_conn zone + description: Returns status of a particular stream + [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone). + operationId: getStreamLimitConnZone + produces: + - application/json + parameters: + - name: fields + in: query + type: string + description: Limits which fields of the + [limit_conn zone](https://nginx.org/en/docs/stream/ngx_stream_limit_conn_module.html#limit_conn_zone) + will be output. + responses: + '200': + description: Success + schema: + $ref: '#/definitions/NginxStreamLimitConnZone' + '404': + description: limit_conn not found (*LimitConnNotFound*) + schema: + $ref: '#/definitions/NginxError' + delete: + tags: + - Stream Limit Conns + - Method DELETE + summary: Reset statistics for a stream limit_conn zone + description: Resets the connection limiting statistics. + operationId: deleteStreamLimitConnZoneStat + responses: + '204': + description: Success + '404': + description: limit_conn not found (*LimitConnNotFound*) + schema: + $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' /stream/upstreams/: get: tags: @@ -2324,6 +2552,72 @@ bytes: 5510647548 responses_written: 200173 bytes_written: 44992 + NginxHTTPLimitConnZonesMap: + title: HTTP limit_conns + description: | + Status data for all HTTP + limit_conn zones. + type: object + additionalProperties: + $ref: '#/definitions/NginxHTTPLimitConnZone' + NginxHTTPLimitConnZone: + title: HTTP Connections Limiting + type: object + properties: + passed: + type: integer + description: The total number of connections that were neither limited + nor accounted as limited. + rejected: + type: integer + description: The total number of connections that were rejected. + rejected_dry_run: + type: integer + description: The total number of connections accounted as rejected in the + dry run + mode. + example: + passed: 15 + rejected: 0 + rejected_dry_run: 2 + NginxHTTPLimitReqZonesMap: + title: HTTP limit_reqs + description: | + Status data for all HTTP + limit_req zones. + type: object + additionalProperties: + $ref: '#/definitions/NginxHTTPLimitReqZone' + NginxHTTPLimitReqZone: + title: HTTP Requests Rate Limiting + type: object + properties: + passed: + type: integer + description: The total number of requests that were neither limited + nor accounted as limited. + delayed: + type: integer + description: The total number of requests that were delayed. + rejected: + type: integer + description: The total number of requests that were rejected. + delayed_dry_run: + type: integer + description: The total number of requests accounted as delayed in the + dry run + mode. + rejected_dry_run: + type: integer + description: The total number of requests accounted as rejected in the + dry run + mode. + example: + passed: 15 + delayed: 4 + rejected: 0 + delayed_dry_run: 1 + rejected_dry_run: 2 NginxHTTPUpstreamMap: title: HTTP Upstreams description: | @@ -2982,6 +3276,34 @@ discarded: 0 received: 4200363 sent: 20489184 + NginxStreamLimitConnZonesMap: + title: Stream limit_conns + description: | + Status data for all stream + limit_conn zones. + type: object + additionalProperties: + $ref: '#/definitions/NginxStreamLimitConnZone' + NginxStreamLimitConnZone: + title: Stream Connections Limiting + type: object + properties: + passed: + type: integer + description: The total number of connections that were neither limited + nor accounted as limited. + rejected: + type: integer + description: The total number of connections that were rejected. + rejected_dry_run: + type: integer + description: The total number of connections accounted as rejected in the + dry run + mode. + example: + passed: 15 + rejected: 0 + rejected_dry_run: 2 NginxStreamUpstreamMap: title: Stream Upstreams description: Status information of stream upstream server groups.