Модуль ngx_http_api_module

Пример конфигурации
Директивы
api
status_zone
Совместимость
Конечные точки
/
/nginx
/processes
/connections
/slabs/
/slabs/{slabZoneName}
/http/
/http/requests
/http/server_zones/
/http/server_zones/{httpServerZoneName}
/http/location_zones/
/http/location_zones/{httpLocationZoneName}
/http/caches/
/http/caches/{httpCacheZoneName}
/http/limit_conns/
/http/limit_conns/{httpLimitConnZoneName}
/http/limit_reqs/
/http/limit_reqs/{httpLimitReqZoneName}
/http/upstreams/
/http/upstreams/{httpUpstreamName}/
/http/upstreams/{httpUpstreamName}/servers/
/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}
/http/keyvals/
/http/keyvals/{httpKeyvalZoneName}
/stream/
/stream/server_zones/
/stream/server_zones/{streamServerZoneName}
/stream/limit_conns/
/stream/limit_conns/{streamLimitConnZoneName}
/stream/upstreams/
/stream/upstreams/{streamUpstreamName}/
/stream/upstreams/{streamUpstreamName}/servers/
/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}
/stream/keyvals/
/stream/keyvals/{streamKeyvalZoneName}
/stream/zone_sync/
/resolvers/
/resolvers/{resolverZoneName}
/ssl
/license
/workers/
/workers/{workerId}
Объекты ответа

Модуль ngx_http_api_module (1.13.3) предоставляет REST API для доступа к различным сведениям о состоянии, динамической настройки групп вышестоящих серверов и управления парами «ключ-значение» без необходимости повторной настройки nginx.

Этот модуль заменяет модули ngx_http_status_module и ngx_http_upstream_conf_module.

При использовании методов PATCH или POST убедитесь, что размер данных не превышает размер буфера для чтения тела запроса клиента; в противном случае может быть возвращена ошибка 413 (Слишком большой размер тела запроса).

Этот модуль доступен в рамках нашей коммерческой подписки.

Пример конфигурации

http {
    upstream backend {
        zone http_backend 64k;

        server backend1.example.com weight=5;
        server backend2.example.com;
    }

    proxy_cache_path /data/nginx/cache_backend keys_zone=cache_backend:10m;

    server {
        server_name backend.example.com;

        location / {
            proxy_pass  http://backend;
            proxy_cache cache_backend;

            health_check;
        }

        status_zone server_backend;
    }

    keyval_zone zone=one:32k state=one.keyval;
    keyval $arg_text $text zone=one;

    server {
        listen 127.0.0.1;

        location /api {
            api write=on;
            allow 127.0.0.1;
            deny all;
        }
    }
}

stream {
    upstream backend {
        zone stream_backend 64k;

        server backend1.example.com:12345 weight=5;
        server backend2.example.com:12345;
    }

    server {
        listen      127.0.0.1:12345;
        proxy_pass  backend;
        status_zone server_backend;
        health_check;
    }
}

Все запросы API содержат поддерживаемую версию API в URI. Примеры запросов API с такой конфигурацией:

http://127.0.0.1/api/9/
http://127.0.0.1/api/9/nginx
http://127.0.0.1/api/9/connections
http://127.0.0.1/api/9/workers
http://127.0.0.1/api/9/http/requests
http://127.0.0.1/api/9/http/server_zones/server_backend
http://127.0.0.1/api/9/http/caches/cache_backend
http://127.0.0.1/api/9/http/upstreams/backend
http://127.0.0.1/api/9/http/upstreams/backend/servers/
http://127.0.0.1/api/9/http/upstreams/backend/servers/1
http://127.0.0.1/api/9/http/keyvals/one?key=arg1
http://127.0.0.1/api/9/stream/
http://127.0.0.1/api/9/stream/server_zones/server_backend
http://127.0.0.1/api/9/stream/upstreams/
http://127.0.0.1/api/9/stream/upstreams/backend
http://127.0.0.1/api/9/stream/upstreams/backend/servers/1

Директивы

Синтаксис:	`api [write=on\|off];`
Значение по умолчанию:	—
Контекст:	`location`

Включает интерфейс REST API в окружающем location. Доступ к этому location следует ограничить.

Параметр write определяет, будет ли API доступен только для чтения или для чтения и записи. По умолчанию API доступен только для чтения.

Все запросы API должны содержать поддерживаемую версию API в URI. Если URI запроса совпадает с префиксом location, возвращается список поддерживаемых версий API. Текущая версия API — «9».

Необязательный аргумент «fields» в строке запроса указывает, какие поля запрошенных объектов будут выведены:

http://127.0.0.1/api/9/nginx?fields=version,build

Синтаксис:	`status_zone zone;`
Значение по умолчанию:	—
Контекст:	`server`, `location`, `if in location`

Эта директива появилась в версии 1.13.12.

Включает сбор сведений о состоянии виртуальных серверов http или stream в указанной зоне zone. Несколько серверов могут использовать одну зону.

Начиная с версии 1.17.0, сведения о состоянии можно собирать отдельно для каждого location. Специальное значение off отключает сбор статистики во вложенных блоках location. Обратите внимание, что статистика собирается в контексте location, в котором завершается обработка. Он может отличаться от исходного location, если во время обработки запроса происходит внутренняя переадресация.

Совместимость

Данные «response_time_hist» для каждого HTTP-upstream добавлены в версии 9 (1.29.8).
Поле «uuid» добавлено в данные /license в версии 9 (1.29.0).
Данные /license добавлены в версии 9 (1.27.2).
Данные /workers/ добавлены в версии 9.
Подробные счетчики ошибок добавлены в статистику SSL в версии 8 (1.23.2).
Данные ssl для каждого HTTP-upstream, зоны сервера, а также stream-upstream и зоны сервера добавлены в версии 8 (1.21.6).
Данные codes в responses для каждого HTTP-upstream, зоны сервера и зоны location добавлены в версии 7.
Данные /stream/limit_conns/ добавлены в версии 6.
Данные /http/limit_conns/ добавлены в версии 6.
Данные /http/limit_reqs/ добавлены в версии 6.
Параметр «expire» пары ключ-значение можно задать или изменить, начиная с версии 5.
Данные /resolvers/ добавлены в версии 5.
Данные /http/location_zones/ добавлены в версии 5.
Поля path и method объекта ошибки nginx удалены в версии 4. В предыдущих версиях API эти поля сохраняются, но имеют пустое значение.
Данные /stream/zone_sync/ добавлены в версии 3.
Параметр drain добавлен в версии 2.
Данные /stream/keyvals/ добавлены в версии 2.

Конечные точки

/

Поддерживаемые методы:

GET - Возвращает список корневых конечных точек
Возвращает список корневых конечных точек.

Возможные ответы:
- 200 - Успешно, возвращает массив строк
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/nginx

Поддерживаемые методы:

GET - Возвращает состояние работающего экземпляра nginx
Возвращает версию nginx, имя сборки, адрес, количество перезагрузок конфигурации, идентификаторы главного и рабочих процессов.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей работающего экземпляра nginx.

Возможные ответы:
- 200 - Успешно, возвращает объект nginx
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/processes

Поддерживаемые методы:

GET - Возвращает состояние процессов nginx
Возвращает количество аварийно завершившихся и повторно запущенных дочерних процессов.

Возможные ответы:
- 200 - Успешно, возвращает процессы
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику процессов nginx
Сбрасывает счетчики аварийно завершившихся и повторно запущенных дочерних процессов.

Возможные ответы:
- 204 - Успешно
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/connections

Поддерживаемые методы:

GET - Возвращает статистику клиентских подключений
Возвращает статистику клиентских подключений.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей статистики подключений.

Возможные ответы:
- 200 - Успешно, возвращает подключения
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику клиентских подключений
Сбрасывает статистику принятых и отклоненных клиентских подключений.

Возможные ответы:
- 204 - Успешно
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/slabs/

Поддерживаемые методы:

GET - Возвращает состояние всех slabs
Возвращает состояние slabs для каждой зоны разделяемой памяти с распределителем slabs.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зон slabs. Если значение «fields» пусто, выводятся только имена зон.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «зона разделяемой памяти с распределителем slabs» для всех slabs
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/slabs/{slabZoneName}

Общие для всех методов параметры:

slabZoneName (string, обязательный): Имя зоны разделяемой памяти с распределителем slabs.

Поддерживаемые методы:

GET - Возвращает состояние slab
Возвращает состояние slabs для указанной зоны разделяемой памяти с распределителем slabs.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зоны slab.

Возможные ответы:
- 200 - Успешно, возвращает зону разделяемой памяти с распределителем slabs
- 404 - Slab не найден (SlabNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику slab
Сбрасывает показатели «reqs» и «fails» для каждого слота памяти.

Возможные ответы:
- 204 - Успешно
- 404 - Slab не найден (SlabNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/http/

Поддерживаемые методы:

GET - Возвращает список конечных точек, связанных с HTTP
Возвращает список конечных точек HTTP первого уровня.

Возможные ответы:
- 200 - Успешно, возвращает массив строк
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/http/requests

Поддерживаемые методы:

GET - Возвращает статистику HTTP-запросов
Возвращает состояние HTTP-запросов клиентов.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей статистики HTTP-запросов клиентов.

Возможные ответы:
- 200 - Успешно, возвращает HTTP-запросы
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику HTTP-запросов
Сбрасывает общее количество HTTP-запросов клиентов.

Возможные ответы:
- 204 - Успешно
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/http/server_zones/

Поддерживаемые методы:

GET - Возвращает состояние всех зон HTTP-серверов
Возвращает информацию о состоянии каждой зоны сервера HTTP.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зон серверов. Если значение «fields» пусто, выводятся только имена зон серверов.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «зона HTTP-сервера» для всех зон HTTP-серверов
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/http/server_zones/{httpServerZoneName}

Общие для всех методов параметры:

httpServerZoneName (string, обязательный): Имя зоны HTTP-сервера.

Поддерживаемые методы:

GET - Возвращает состояние зоны HTTP-сервера
Возвращает состояние указанной зоны HTTP-сервера.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зоны сервера.

Возможные ответы:
- 200 - Успешно, возвращает зону HTTP-сервера
- 404 - Зона сервера не найдена (ServerZoneNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику зоны HTTP-сервера
Сбрасывает статистику принятых и отброшенных запросов, ответов, полученных и отправленных байтов, счетчики SSL-рукопожатий и повторного использования сеансов в указанной зоне HTTP-сервера.

Возможные ответы:
- 204 - Успешно
- 404 - Зона сервера не найдена (ServerZoneNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/http/location_zones/

Поддерживаемые методы:

GET - Возвращает состояние всех зон HTTP-локаций
Возвращает информацию о состоянии каждой зоны локации HTTP.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зон локаций. Если значение «fields» пусто, выводятся только имена зон.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «зона HTTP-локации» для всех зон HTTP-локаций
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/http/location_zones/{httpLocationZoneName}

Общие для всех методов параметры:

httpLocationZoneName (string, обязательный): Имя зоны локации HTTP.

Поддерживаемые методы:

GET - Возвращает состояние зоны HTTP-локации
Возвращает состояние указанной зоны локации HTTP.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зоны локации.

Возможные ответы:
- 200 - Успешно, возвращает зону HTTP-локации
- 404 - Зона локации не найдена (LocationZoneNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику зоны локации.
Сбрасывает статистику принятых и отброшенных запросов, ответов, полученных и отправленных байтов в указанной зоне локации.

Возможные ответы:
- 204 - Успешно
- 404 - Зона локации не найдена (LocationZoneNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/http/caches/

Поддерживаемые методы:

GET - Возвращает состояние всех кэшей
Возвращает состояние каждого кэша, настроенного с помощью proxy_cache_path и других директив «*_cache_path».

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зон кэша. Если значение «fields» пусто, выводятся только имена зон кэша.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «HTTP-кэш» для всех HTTP-кэшей
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/http/caches/{httpCacheZoneName}

Общие для всех методов параметры:

httpCacheZoneName (string, обязательный): Имя зоны кэша.

Поддерживаемые методы:

GET - Возвращает состояние кэша
Возвращает состояние указанного кэша.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зоны кэша.

Возможные ответы:
- 200 - Успешно, возвращает HTTP-кэш
- 404 - Кэш не найден (CacheNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику кэша
Сбрасывает статистику попаданий и промахов кэша в указанной зоне кэша.

Возможные ответы:
- 204 - Успешно
- 404 - Кэш не найден (CacheNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/http/limit_conns/

Поддерживаемые методы:

GET - Возвращает состояние всех зон HTTP limit_conn
Возвращает информацию о состоянии каждой зоны limit_conn HTTP.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зон limit_conn. Если значение «fields» пусто, выводятся только имена зон.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «ограничение HTTP-подключений» для всех зон HTTP limit_conn
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/http/limit_conns/{httpLimitConnZoneName}

Общие для всех методов параметры:

httpLimitConnZoneName (string, обязательный): Имя зоны limit_conn.

Поддерживаемые методы:

GET - Возвращает состояние зоны HTTP limit_conn
Возвращает состояние указанной зоны limit_conn HTTP.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зоны limit_conn.

Возможные ответы:
- 200 - Успешно, возвращает ограничение HTTP-подключений
- 404 - limit_conn не найден (LimitConnNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику зоны HTTP limit_conn
Сбрасывает статистику ограничения подключений.

Возможные ответы:
- 204 - Успешно
- 404 - limit_conn не найден (LimitConnNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/http/limit_reqs/

Поддерживаемые методы:

GET - Возвращает состояние всех зон HTTP limit_req
Возвращает информацию о состоянии каждой зоны limit_req HTTP.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зон limit_req. Если значение «fields» пусто, выводятся только имена зон.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «ограничение частоты HTTP-запросов» для всех зон HTTP limit_req
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/http/limit_reqs/{httpLimitReqZoneName}

Общие для всех методов параметры:

httpLimitReqZoneName (string, обязательный): Имя зоны limit_req.

Поддерживаемые методы:

GET - Возвращает состояние зоны HTTP limit_req
Возвращает состояние указанной зоны limit_req HTTP.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зоны limit_req.

Возможные ответы:
- 200 - Успешно, возвращает ограничение частоты HTTP-запросов
- 404 - limit_req не найден (LimitReqNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику зоны HTTP limit_req
Сбрасывает статистику ограничения частоты запросов.

Возможные ответы:
- 204 - Успешно
- 404 - limit_req не найден (LimitReqNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/http/upstreams/

Поддерживаемые методы:

GET - Возвращает состояние всех групп HTTP upstream-серверов
Возвращает состояние каждой группы HTTP upstream-серверов и входящих в нее серверов.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей групп upstream-серверов. Если значение «fields» пусто, выводятся только имена upstream.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «HTTP upstream» для всех HTTP upstream
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/http/upstreams/{httpUpstreamName}/

Общие для всех методов параметры:

httpUpstreamName (string, обязательный): Имя группы HTTP upstream-серверов.

Поддерживаемые методы:

GET - Возвращает состояние группы HTTP upstream-серверов
Возвращает состояние указанной группы HTTP upstream-серверов и входящих в нее серверов.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей группы upstream-серверов.

Возможные ответы:
- 200 - Успешно, возвращает HTTP upstream
- 400 - Upstream статический (UpstreamStatic), возвращает ошибку
- 404 - Неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
DELETE - Сбрасывает статистику группы HTTP upstream-серверов
Сбрасывает статистику каждого upstream-сервера в группе, а также статистику очереди.

Возможные ответы:
- 204 - Успешно
- 400 - Upstream статический (UpstreamStatic), возвращает ошибку
- 404 - Неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/http/upstreams/{httpUpstreamName}/servers/

Общие для всех методов параметры:

httpUpstreamName (string, обязательный): Имя группы upstream-серверов.

Поддерживаемые методы:

GET - Возвращает конфигурацию всех серверов в группе HTTP upstream-серверов
Возвращает конфигурацию каждого сервера в указанной группе HTTP upstream-серверов.

Возможные ответы:
- 200 - Успешно, возвращает массив HTTP upstream-серверов
- 400 - Upstream статический (UpstreamStatic), возвращает ошибку
- 404 - Неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
POST - Добавляет сервер в группу HTTP upstream-серверов
Добавляет новый сервер в группу HTTP upstream-серверов. Параметры сервера задаются в формате JSON.

Параметры запроса:

postHttpUpstreamServer (HTTP upstream-сервер, обязательный)

Адрес нового сервера и другие необязательные параметры в формате JSON. Параметры «ID», «backup» и «service» изменить нельзя.

Возможные ответы:
- 201 - Создано, возвращает HTTP upstream-сервер
- 400 - Upstream статический (UpstreamStatic), недопустимое значение «parameter» (UpstreamConfFormatError), отсутствует аргумент «server» (UpstreamConfFormatError), неизвестный параметр «name» (UpstreamConfFormatError), вложенный объект или список (UpstreamConfFormatError), «error» при разборе (UpstreamBadAddress), service upstream «host» не может иметь порт (UpstreamBadAddress), service upstream «host» требует доменное имя (UpstreamBadAddress), недопустимое значение «weight» (UpstreamBadWeight), недопустимое значение «max_conns» (UpstreamBadMaxConns), недопустимое значение «max_fails» (UpstreamBadMaxFails), недопустимое значение «fail_timeout» (UpstreamBadFailTimeout), недопустимое значение «slow_start» (UpstreamBadSlowStart), ошибка чтения тела запроса BodyReadError), слишком длинный маршрут (UpstreamBadRoute), «service» пусто (UpstreamBadService), для разрешения имени не задан резолвер (UpstreamConfNoResolver), у upstream «name» отсутствует резервный сервер (UpstreamNoBackup), исчерпана память upstream «name» (UpstreamOutOfMemory), возвращает ошибку
- 404 - Неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку
- 409 - Запись существует (EntryExists), возвращает ошибку
- 415 - Ошибка JSON (JsonError), возвращает ошибку

/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}

Общие для всех методов параметры:

httpUpstreamName (string, обязательный): Имя группы upstream-серверов.
httpUpstreamServerId (string, обязательный): Идентификатор сервера.

Поддерживаемые методы:

GET - Возвращает конфигурацию сервера в группе HTTP upstream-серверов
Возвращает конфигурацию указанного сервера в группе HTTP upstream-серверов.

Возможные ответы:
- 200 - Успешно, возвращает HTTP upstream-сервер
- 400 - Upstream статический (UpstreamStatic), недопустимый идентификатор сервера (UpstreamBadServerId), возвращает ошибку
- 404 - Сервер с идентификатором «id» не существует (UpstreamServerNotFound), неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
PATCH - Изменяет сервер в группе HTTP upstream-серверов
Изменяет параметры указанного сервера в группе HTTP upstream-серверов. Параметры сервера задаются в формате JSON.

Параметры запроса:

patchHttpUpstreamServer (HTTP upstream-сервер, обязательный)

Параметры сервера в формате JSON. Параметры «ID», «backup» и «service» изменить нельзя.

Возможные ответы:
- 200 - Успешно, возвращает HTTP upstream-сервер
- 400 - Upstream статический (UpstreamStatic), недопустимое значение «parameter» (UpstreamConfFormatError), неизвестный параметр «name» (UpstreamConfFormatError), вложенный объект или список (UpstreamConfFormatError), «error» при разборе (UpstreamBadAddress), недопустимый аргумент «server» (UpstreamBadAddress), недопустимый идентификатор сервера (UpstreamBadServerId), недопустимое значение «weight» (UpstreamBadWeight), недопустимое значение «max_conns» (UpstreamBadMaxConns), недопустимое значение «max_fails» (UpstreamBadMaxFails), недопустимое значение «fail_timeout» (UpstreamBadFailTimeout), недопустимое значение «slow_start» (UpstreamBadSlowStart), ошибка чтения тела запроса BodyReadError), слишком длинный маршрут (UpstreamBadRoute), «service» пусто (UpstreamBadService), адрес сервера «ID» нельзя изменить (UpstreamServerImmutable), вес сервера «ID» нельзя изменить (UpstreamServerWeightImmutable), исчерпана память upstream «name» (UpstreamOutOfMemory), возвращает ошибку
- 404 - Сервер с идентификатором «id» не существует (UpstreamServerNotFound), неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку
- 415 - Ошибка JSON (JsonError), возвращает ошибку
DELETE - Удаляет сервер из группы HTTP upstream-серверов
Удаляет сервер из группы HTTP upstream-серверов.

Возможные ответы:
- 200 - Успешно, возвращает массив HTTP upstream-серверов
- 400 - Upstream статический (UpstreamStatic), недопустимый идентификатор сервера (UpstreamBadServerId), сервер «id» нельзя удалить (UpstreamServerImmutable), возвращает ошибку
- 404 - Сервер с идентификатором «id» не существует (UpstreamServerNotFound), неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
- 405 - Метод отключен (MethodDisabled), возвращает ошибку

/http/keyvals/

Поддерживаемые методы:

GET - Возвращает пары «ключ–значение» из всех зон HTTP keyval
Возвращает пары «ключ–значение» для каждой зоны разделяемой памяти HTTP keyval.

Параметры запроса:

fields (string, необязательный)

Если значение «fields» пусто, выводятся только имена зон HTTP keyval.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «Зона разделяемой памяти HTTP Keyval» для всех HTTP keyval
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/http/keyvals/{httpKeyvalZoneName}

Общие параметры для всех методов:

httpKeyvalZoneName (string, обязательный): Имя зоны разделяемой памяти HTTP keyval.

Поддерживаемые методы:

GET - Возвращает пары «ключ–значение» из зоны HTTP keyval
Возвращает пары «ключ–значение», хранящиеся в указанной зоне разделяемой памяти HTTP keyval.

Параметры запроса:

key (string, необязательный)

Получить указанную пару «ключ–значение» из зоны HTTP keyval.

Возможные ответы:
- 200 - Успешно, возвращает зону разделяемой памяти HTTP Keyval
- 404 - Keyval не найден (KeyvalNotFound), ключ keyval не найден (KeyvalKeyNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
POST - Добавляет пару «ключ–значение» в зону HTTP keyval
Добавляет новую пару «ключ–значение» в зону разделяемой памяти HTTP keyval. Если зона разделяемой памяти HTTP keyval пуста, можно добавить несколько пар «ключ–значение».

Параметры запроса:

Key-value (зона разделяемой памяти HTTP Keyval, обязательный)

Пара «ключ–значение» задаётся в формате JSON. Если зона разделяемой памяти HTTP keyval пуста, можно добавить несколько пар «ключ–значение». Для пары «ключ–значение» можно задать время истечения срока действия в миллисекундах с помощью параметра expire, который переопределяет параметр timeout директивы keyval_zone.

Возможные ответы:
- 201 - Создано
- 400 - Недопустимый JSON (KeyvalFormatError), недопустимый формат ключа (KeyvalFormatError), требуется ключ (KeyvalFormatError), время ожидания keyval не включено (KeyvalFormatError), можно добавить только один ключ (KeyvalFormatError), ошибка чтения тела запроса BodyReadError), возвращает ошибку
- 404 - Keyval не найден (KeyvalNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку
- 409 - Запись существует (EntryExists), ключ уже существует (KeyvalKeyExists), возвращает ошибку
- 413 - Слишком большой объект запроса, возвращает ошибку
- 415 - Ошибка JSON (JsonError), возвращает ошибку
PATCH - Изменяет пару «ключ–значение» или удаляет ключ
Изменяет значение выбранного ключа в паре «ключ–значение», удаляет ключ, задавая для него значение null, или изменяет время истечения срока действия пары «ключ–значение». Если синхронизация зон keyval в кластере включена, ключ удаляется только на целевом узле кластера. Для пары «ключ–значение» можно задать время истечения срока действия в миллисекундах с помощью параметра expire, который переопределяет параметр timeout директивы keyval_zone.

Параметры запроса:

httpKeyvalZoneKeyValue (зона разделяемой памяти HTTP Keyval, обязательный)

Новое значение ключа задаётся в формате JSON.

Возможные ответы:
- 204 - Успешно
- 400 - Недопустимый JSON (KeyvalFormatError), требуется ключ (KeyvalFormatError), время ожидания keyval не включено (KeyvalFormatError), можно обновить только один ключ (KeyvalFormatError), ошибка чтения тела запроса BodyReadError), возвращает ошибку
- 404 - Keyval не найден (KeyvalNotFound), ключ keyval не найден (KeyvalKeyNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку
- 413 - Слишком большой объект запроса, возвращает ошибку
- 415 - Ошибка JSON (JsonError), возвращает ошибку
DELETE - Очищает зону HTTP keyval
Удаляет все пары «ключ–значение» из зоны разделяемой памяти HTTP keyval. Если синхронизация зон keyval в кластере включена, зона keyval очищается только на целевом узле кластера.

Возможные ответы:
- 204 - Успешно
- 404 - Keyval не найден (KeyvalNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку

/stream/

Поддерживаемые методы:

GET - Возвращает список конечных точек, связанных с потоками
Возвращает список конечных точек потоков первого уровня.

Возможные ответы:
- 200 - Успешно, возвращает массив строк
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/stream/server_zones/

Поддерживаемые методы:

GET - Возвращает состояние всех зон серверов потоков
Возвращает сведения о состоянии каждой зоны сервера потоков.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зон серверов. Если значение «fields» пусто, выводятся только имена зон серверов.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «Зона сервера потоков» для всех зон серверов потоков
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/stream/server_zones/{streamServerZoneName}

Общие параметры для всех методов:

streamServerZoneName (string, обязательный): Имя зоны сервера потоков.

Поддерживаемые методы:

GET - Возвращает состояние зоны сервера потоков
Возвращает состояние указанной зоны сервера потоков.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зоны сервера.

Возможные ответы:
- 200 - Успешно, возвращает зону сервера потоков
- 404 - Зона сервера не найдена (ServerZoneNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику зоны сервера потоков
Сбрасывает статистику принятых и отклонённых соединений, сеансов, полученных и отправленных байтов, счётчики SSL-рукопожатий и повторного использования сеансов в указанной зоне сервера потоков.

Возможные ответы:
- 204 - Успешно
- 404 - Зона сервера не найдена (ServerZoneNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку

/stream/limit_conns/

Поддерживаемые методы:

GET - Возвращает состояние всех зон stream limit_conn
Возвращает сведения о состоянии каждой зоны limit_conn потоков.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зон limit_conn. Если значение «fields» пусто, выводятся только имена зон.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «Ограничение соединений в потоках» для всех зон stream limit_conn
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/stream/limit_conns/{streamLimitConnZoneName}

Общие параметры для всех методов:

streamLimitConnZoneName (string, обязательный): Имя зоны limit_conn.

Поддерживаемые методы:

GET - Возвращает состояние зоны stream limit_conn
Возвращает состояние указанной зоны limit_conn потоков.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей зоны limit_conn.

Возможные ответы:
- 200 - Успешно, возвращает объект ограничения соединений в потоках
- 404 - limit_conn не найден (LimitConnNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
DELETE - Сбрасывает статистику зоны stream limit_conn
Сбрасывает статистику ограничения соединений.

Возможные ответы:
- 204 - Успешно
- 404 - limit_conn не найден (LimitConnNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку

/stream/upstreams/

Поддерживаемые методы:

GET - Возвращает состояние всех групп серверов upstream потоков
Возвращает состояние каждой группы серверов upstream потоков и её серверов.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей групп серверов upstream. Если значение «fields» пусто, выводятся только имена upstream.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «Upstream потоков» для всех upstream потоков
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/stream/upstreams/{streamUpstreamName}/

Общие параметры для всех методов:

streamUpstreamName (string, обязательный): Имя группы серверов upstream потоков.

Поддерживаемые методы:

GET - Возвращает состояние группы серверов upstream потоков
Возвращает состояние указанной группы серверов upstream потоков и её серверов.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей группы серверов upstream.

Возможные ответы:
- 200 - Успешно, возвращает upstream потоков
- 400 - Upstream является статическим (UpstreamStatic), возвращает ошибку
- 404 - Неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
DELETE - Сбрасывает статистику группы серверов upstream потоков
Сбрасывает статистику каждого сервера upstream в группе серверов upstream.

Возможные ответы:
- 204 - Успешно
- 400 - Upstream является статическим (UpstreamStatic), возвращает ошибку
- 404 - Неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку

/stream/upstreams/{streamUpstreamName}/servers/

Общие параметры для всех методов:

streamUpstreamName (string, обязательный): Имя группы серверов upstream.

Поддерживаемые методы:

GET - Возвращает конфигурацию всех серверов в группе серверов upstream потоков
Возвращает конфигурацию каждого сервера в указанной группе серверов upstream потоков.

Возможные ответы:
- 200 - Успешно, возвращает массив серверов upstream потоков
- 400 - Upstream является статическим (UpstreamStatic), возвращает ошибку
- 404 - Неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
POST - Добавляет сервер в группу серверов upstream потоков
Добавляет новый сервер в группу серверов upstream потоков. Параметры сервера задаются в формате JSON.

Параметры запроса:

postStreamUpstreamServer (сервер upstream потоков, обязательный)

Адрес нового сервера и другие необязательные параметры в формате JSON. Параметры «ID», «backup» и «service» изменить нельзя.

Возможные ответы:
- 201 - Создано, возвращает сервер upstream потоков
- 400 - Upstream является статическим (UpstreamStatic), недопустимое значение «parameter» (UpstreamConfFormatError), отсутствует аргумент «server» (UpstreamConfFormatError), неизвестный параметр «name» (UpstreamConfFormatError), вложенный объект или список (UpstreamConfFormatError), ошибка при разборе «error» (UpstreamBadAddress), в сервере «host» отсутствует порт (UpstreamBadAddress), в upstream службы «host» не может быть порта (UpstreamBadAddress), для upstream службы «host» требуется доменное имя (UpstreamBadAddress), недопустимое значение «weight» (UpstreamBadWeight), недопустимое значение «max_conns» (UpstreamBadMaxConns), недопустимое значение «max_fails» (UpstreamBadMaxFails), недопустимое значение «fail_timeout» (UpstreamBadFailTimeout), недопустимое значение «slow_start» (UpstreamBadSlowStart), значение «service» пусто (UpstreamBadService), для разрешения имени «UpstreamConfNoResolver» не задан резолвер, у upstream «name» отсутствует резервный сервер (UpstreamNoBackup), у upstream «name» недостаточно памяти (UpstreamOutOfMemory), ошибка чтения тела запроса BodyReadError), возвращает ошибку
- 404 - Неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку
- 409 - Запись существует (EntryExists), возвращает ошибку
- 415 - Ошибка JSON (JsonError), возвращает ошибку

/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}

Общие параметры для всех методов:

streamUpstreamName (string, обязательный): Имя группы серверов upstream.
streamUpstreamServerId (string, обязательный): Идентификатор сервера.

Поддерживаемые методы:

GET - Возвращает конфигурацию сервера в группе серверов upstream потоков
Возвращает конфигурацию указанного сервера в группе серверов upstream потоков.

Возможные ответы:
- 200 - Успешно, возвращает сервер upstream потоков
- 400 - Upstream является статическим (UpstreamStatic), недопустимый идентификатор сервера (UpstreamBadServerId), возвращает ошибку
- 404 - Неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), сервер с идентификатором «id» не существует (UpstreamServerNotFound), возвращает ошибку
PATCH - Изменяет сервер в группе серверов upstream потоков
Изменяет настройки указанного сервера в группе серверов upstream потоков. Параметры сервера задаются в формате JSON.

Параметры запроса:

patchStreamUpstreamServer (сервер upstream потоков, обязательный)

Параметры сервера в формате JSON. Параметры «ID», «backup» и «service» изменить нельзя.

Возможные ответы:
- 200 - Успешно, возвращает сервер upstream потоков
- 400 - Upstream является статическим (UpstreamStatic), недопустимое значение «parameter» (UpstreamConfFormatError), неизвестный параметр «name» (UpstreamConfFormatError), вложенный объект или список (UpstreamConfFormatError), ошибка при разборе «error» (UpstreamBadAddress), недопустимый аргумент «server» (UpstreamBadAddress), в сервере «host» отсутствует порт (UpstreamBadAddress), недопустимый идентификатор сервера (UpstreamBadServerId), недопустимое значение «weight» (UpstreamBadWeight), недопустимое значение «max_conns» (UpstreamBadMaxConns), недопустимое значение «max_fails» (UpstreamBadMaxFails), недопустимое значение «fail_timeout» (UpstreamBadFailTimeout), недопустимое значение «slow_start» (UpstreamBadSlowStart), ошибка чтения тела запроса BodyReadError), значение «service» пусто (UpstreamBadService), адрес сервера «ID» неизменяем (UpstreamServerImmutable), вес сервера «ID» неизменяем (UpstreamServerWeightImmutable), у upstream «name» недостаточно памяти (UpstreamOutOfMemory), возвращает ошибку
- 404 - Сервер с идентификатором «id» не существует (UpstreamServerNotFound), неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку
- 415 - Ошибка JSON (JsonError), возвращает ошибку
DELETE - Удаляет сервер из группы серверов upstream потоков
Удаляет сервер из группы серверов потоков.

Возможные ответы:
- 200 - Успешно, возвращает массив серверов upstream потоков
- 400 - Upstream является статическим (UpstreamStatic), недопустимый идентификатор сервера (UpstreamBadServerId), сервер «id» нельзя удалить (UpstreamServerImmutable), возвращает ошибку
- 404 - Сервер с идентификатором «id» не существует (UpstreamServerNotFound), неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку

/stream/keyvals/

Поддерживаемые методы:

GET - Возвращает пары «ключ–значение» из всех зон stream keyval
Возвращает пары «ключ–значение» для каждой зоны разделяемой памяти stream keyval.

Параметры запроса:

fields (string, необязательный)

Если значение «fields» пусто, выводятся только имена зон stream keyval.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «Зона разделяемой памяти Stream Keyval» для всех stream keyval
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/stream/keyvals/{streamKeyvalZoneName}

Общие параметры для всех методов:

streamKeyvalZoneName (string, обязательный): Имя зоны разделяемой памяти stream keyval.

Поддерживаемые методы:

GET - Возвращает пары «ключ–значение» из зоны stream keyval
Возвращает пары «ключ–значение», хранящиеся в указанной зоне разделяемой памяти stream keyval.

Параметры запроса:

key (string, необязательный)

Получить указанную пару «ключ–значение» из зоны stream keyval.

Возможные ответы:
- 200 - Успешно, возвращает зону разделяемой памяти Stream Keyval
- 404 - Keyval не найден (KeyvalNotFound), ключ keyval не найден (KeyvalKeyNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
POST - Добавляет пару «ключ–значение» в зону stream keyval
Добавляет новую пару «ключ–значение» в зону разделяемой памяти stream keyval. Если зона разделяемой памяти stream keyval пуста, можно добавить несколько пар «ключ–значение».

Параметры запроса:

Key-value (зона разделяемой памяти Stream Keyval, обязательный)

Пара «ключ–значение» задаётся в формате JSON. Если зона разделяемой памяти stream keyval пуста, можно добавить несколько пар «ключ–значение». Для пары «ключ–значение» можно задать время истечения срока действия в миллисекундах с помощью параметра expire, который переопределяет параметр timeout директивы keyval_zone.

Возможные ответы:
- 201 - Создано
- 400 - Недопустимый JSON (KeyvalFormatError), недопустимый формат ключа (KeyvalFormatError), требуется ключ (KeyvalFormatError), время ожидания keyval не включено (KeyvalFormatError), можно добавить только один ключ (KeyvalFormatError), ошибка чтения тела запроса BodyReadError), возвращает ошибку
- 404 - Keyval не найден (KeyvalNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку
- 409 - Запись существует (EntryExists), ключ уже существует (KeyvalKeyExists), возвращает ошибку
- 413 - Слишком большой объект запроса, возвращает ошибку
- 415 - Ошибка JSON (JsonError), возвращает ошибку
PATCH - Изменяет пару «ключ–значение» или удаляет ключ
Изменяет значение выбранного ключа в паре «ключ–значение», удаляет ключ, задавая для него значение null, или изменяет время истечения срока действия пары «ключ–значение». Если синхронизация зон keyval в кластере включена, ключ удаляется только на целевом узле кластера. Время истечения срока действия задаётся в миллисекундах параметром expire, который переопределяет параметр timeout директивы keyval_zone.

Параметры запроса:

streamKeyvalZoneKeyValue (зона разделяемой памяти Stream Keyval, обязательный)

Новое значение ключа задаётся в формате JSON.

Возможные ответы:
- 204 - Успешно
- 400 - Недопустимый JSON (KeyvalFormatError), требуется ключ (KeyvalFormatError), время ожидания keyval не включено (KeyvalFormatError), можно обновить только один ключ (KeyvalFormatError), ошибка чтения тела запроса BodyReadError), возвращает ошибку
- 404 - Keyval не найден (KeyvalNotFound), ключ keyval не найден (KeyvalKeyNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку
- 413 - Слишком большой объект запроса, возвращает ошибку
- 415 - Ошибка JSON (JsonError), возвращает ошибку
DELETE - Очищает зону stream keyval
Удаляет все пары «ключ–значение» из зоны разделяемой памяти stream keyval. Если синхронизация зон keyval в кластере включена, зона keyval очищается только на целевом узле кластера.

Возможные ответы:
- 204 - Успешно
- 404 - Keyval не найден (KeyvalNotFound), неизвестная версия (UnknownVersion), возвращает ошибку
- 405 - Метод отключён (MethodDisabled), возвращает ошибку

/stream/zone_sync/

Поддерживаемые методы:

GET - Возвращает состояние синхронизации узла
Возвращает состояние синхронизации узла кластера.

Возможные ответы:
- 200 - Успешно, возвращает узел синхронизации зоны потоков
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/resolvers/

Поддерживаемые методы:

GET - Возвращает состояние всех зон резолверов
Возвращает сведения о состоянии каждой зоны резолвера.

Параметры запроса:

fields (string, необязательный)

Ограничивает набор выводимых полей статистики резолверов.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «Зона резолвера» для всех резолверов
- 404 - Неизвестная версия (UnknownVersion), возвращает ошибку

/resolvers/{resolverZoneName}

Параметры, общие для всех методов:

resolverZoneName (string, обязательно): Имя зоны резолвера.

Поддерживаемые методы:

GET - Возвращает статистику зоны резолвера
Возвращает статистику, хранящуюся в определенной зоне резолвера.

Параметры запроса:

fields (string, необязательно)

Ограничивает список выводимых полей статистики зоны резолвера (запросы, ответы или и то и другое).

Возможные ответы:
- 200 - Успешно, возвращает Зону резолвера
- 404 - Зона резолвера не найдена (ResolverZoneNotFound), неизвестная версия (UnknownVersion), возвращает Ошибка
DELETE - Сбрасывает статистику зоны резолвера.
Сбрасывает статистику в определенной зоне резолвера.

Возможные ответы:
- 204 - Успешно
- 404 - Зона резолвера не найдена (ResolverZoneNotFound), неизвестная версия (UnknownVersion), возвращает Ошибка
- 405 - Метод отключен (MethodDisabled), возвращает Ошибка

/ssl

Поддерживаемые методы:

GET - Возвращает статистику SSL
Возвращает статистику SSL.

Параметры запроса:

fields (string, необязательно)

Ограничивает список выводимых полей статистики SSL.

Возможные ответы:
- 200 - Успешно, возвращает объект SSL
- 404 - Неизвестная версия (UnknownVersion), возвращает Ошибка
DELETE - Сбрасывает статистику SSL
Сбрасывает счетчики рукопожатий SSL и повторного использования сеансов.

Возможные ответы:
- 204 - Успешно
- 404 - Неизвестная версия (UnknownVersion), возвращает Ошибка
- 405 - Метод отключен (MethodDisabled), возвращает Ошибка

/license

Поддерживаемые методы:

GET - Возвращает информацию о лицензии
Возможные ответы:
- 200 - Успешно, возвращает Лицензию
- 404 - Неизвестная версия (UnknownVersion), возвращает Ошибка

/workers/

Поддерживаемые методы:

GET - Возвращает статистику всех рабочих процессов
Возвращает статистику всех рабочих процессов, например количество принятых, отброшенных, активных и простаивающих соединений, а также общее количество и текущее число запросов.

Параметры запроса:

fields (string, необязательно)

Ограничивает список выводимых полей статистики рабочих процессов.

Возможные ответы:
- 200 - Успешно, возвращает коллекцию объектов «Рабочий процесс» для всех рабочих процессов
- 404 - Рабочий процесс не найден (WorkerNotFound), неизвестная версия (UnknownVersion), возвращает Ошибка
DELETE - Сбрасывает статистику всех рабочих процессов.
Сбрасывает статистику всех рабочих процессов, например количество принятых, отброшенных, активных и простаивающих соединений, а также общее количество и текущее число запросов.

Возможные ответы:
- 204 - Успешно
- 404 - Рабочий процесс не найден (WorkerNotFound), неизвестная версия (UnknownVersion), возвращает Ошибка
- 405 - Метод отключен (MethodDisabled), возвращает Ошибка

/workers/{workerId}

Параметры, общие для всех методов:

workerId (string, обязательно): Идентификатор рабочего процесса.

Поддерживаемые методы:

GET - Возвращает состояние рабочего процесса
Возвращает состояние определенного рабочего процесса.

Параметры запроса:

fields (string, необязательно)

Ограничивает список выводимых полей статистики рабочего процесса.

Возможные ответы:
- 200 - Успешно, возвращает Рабочий процесс
- 404 - Рабочий процесс не найден (WorkerNotFound), неизвестная версия (UnknownVersion), возвращает Ошибка
DELETE - Сбрасывает статистику рабочего процесса.
Сбрасывает статистику принятых, отброшенных, активных и простаивающих соединений, а также общего количества и текущего числа запросов.

Возможные ответы:
- 204 - Успешно
- 404 - Рабочий процесс не найден (WorkerNotFound), неизвестная версия (UnknownVersion), возвращает Ошибка
- 405 - Метод отключен (MethodDisabled), возвращает Ошибка

Объекты ответа

nginx:
Общие сведения о nginx:

version (string)

Версия nginx.

build (string)

Название сборки nginx.

address (string)

Адрес сервера, принявшего запрос состояния.

generation (integer)

Общее количество перезагрузок конфигурации.

load_timestamp (string)

Время последней перезагрузки конфигурации в формате ISO 8601 с точностью до миллисекунд.

timestamp (string)

Текущее время в формате ISO 8601 с точностью до миллисекунд.

pid (integer)

Идентификатор рабочего процесса, обработавшего запрос состояния.

ppid (integer)

Идентификатор главного процесса, запустившего рабочий процесс.

Пример:
```
{
  "nginx" : {
    "version" : "1.21.6",
    "build" : "nginx-plus-r27",
    "address" : "206.251.255.64",
    "generation" : 6,
    "load_timestamp" : "2022-06-28T11:15:44.467Z",
    "timestamp" : "2022-06-28T09:26:07.305Z",
    "pid" : 32212,
    "ppid" : 32210
  }
}
```
Процессы:

respawned (integer)

Общее количество аварийно завершившихся и повторно запущенных дочерних процессов.

Пример:
```
{
  "respawned" : 0
}
```
Соединения:
Количество принятых, отброшенных, активных и простаивающих соединений.

accepted (integer)

Общее количество принятых соединений клиентов.

dropped (integer)

Общее количество отброшенных соединений клиентов.

active (integer)

Текущее количество активных соединений клиентов.

idle (integer)

Текущее количество простаивающих соединений клиентов.

Пример:
```
{
  "accepted" : 4968119,
  "dropped" : 0,
  "active" : 5,
  "idle" : 117
}
```
SSL:

handshakes (integer)

Общее количество успешных SSL-рукопожатий.

handshakes_failed (integer)

Общее количество неудачных SSL-рукопожатий.

session_reuses (integer)

Общее количество повторных использований сеансов во время SSL-рукопожатия.

no_common_protocol (integer)

Количество SSL-рукопожатий, завершившихся ошибкой из-за отсутствия общего протокола.

no_common_cipher (integer)

Количество SSL-рукопожатий, завершившихся ошибкой из-за отсутствия общего шифра.

handshake_timeout (integer)

Количество SSL-рукопожатий, завершившихся ошибкой из-за тайм-аута.

peer_rejected_cert (integer)

Количество неудачных SSL-рукопожатий, при которых nginx предъявил сертификат клиенту, но тот был отклонён с соответствующим сообщением alert.

verify_failures

Ошибки проверки SSL-сертификатов

no_cert (integer)

Клиент не предоставил требуемый сертификат.

expired_cert (integer)

Клиент предъявил просроченный или ещё не действующий сертификат.

revoked_cert (integer)

Клиент предъявил отозванный сертификат.

hostname_mismatch (integer)

Сертификат сервера не соответствует имени узла.

other (integer)

Другие ошибки проверки SSL-сертификатов.

Пример:
```
{
  "handshakes" : 79572,
  "handshakes_failed" : 21025,
  "session_reuses" : 15762,
  "no_common_protocol" : 4,
  "no_common_cipher" : 2,
  "handshake_timeout" : 0,
  "peer_rejected_cert" : 0,
  "verify_failures" : {
    "no_cert" : 0,
    "expired_cert" : 2,
    "revoked_cert" : 1,
    "hostname_mismatch" : 2,
    "other" : 1
  }
}
```

Зона разделяемой памяти с распределителем slab:

Зона разделяемой памяти с распределителем slab

pages

Количество свободных и используемых страниц памяти.

used (integer): Текущее количество используемых страниц памяти.
free (integer): Текущее количество свободных страниц памяти.

slots

Данные состояния для слотов памяти (8, 16, 32, 64, 128 и т. д.)

Коллекция объектов «Слот памяти»

Пример:

{
  "pages" : {
    "used" : 1143,
    "free" : 2928
  },
  "slots" : {
    "8" : {
      "used" : 0,
      "free" : 0,
      "reqs" : 0,
      "fails" : 0
    },
    "16" : {
      "used" : 0,
      "free" : 0,
      "reqs" : 0,
      "fails" : 0
    },
    "32" : {
      "used" : 0,
      "free" : 0,
      "reqs" : 0,
      "fails" : 0
    },
    "64" : {
      "used" : 1,
      "free" : 63,
      "reqs" : 1,
      "fails" : 0
    },
    "128" : {
      "used" : 0,
      "free" : 0,
      "reqs" : 0,
      "fails" : 0
    },
    "256" : {
      "used" : 18078,
      "free" : 178,
      "reqs" : 1635736,
      "fails" : 0
    }
  }
}

Слот памяти:

used (integer)

Текущее количество используемых слотов памяти.

free (integer)

Текущее количество свободных слотов памяти.

reqs (integer)

Общее количество попыток выделить память указанного размера.

fails (integer)

Количество неудачных попыток выделить память указанного размера.
HTTP-запросы:

total (integer)

Общее количество запросов клиентов.

current (integer)

Текущее количество запросов клиентов.

Пример:
```
{
  "total" : 10624511,
  "current" : 4
}
```
Зона HTTP-сервера:

processing (integer)

Количество запросов клиентов, обрабатываемых в данный момент.

requests (integer)

Общее количество запросов, полученных от клиентов.

responses

Общее количество ответов, отправленных клиентам, количество ответов с кодами состояния «1xx», «2xx», «3xx», «4xx» и «5xx», а также количество ответов для каждого кода состояния.

1xx (integer)

Количество ответов с кодами состояния «1xx».

2xx (integer)

Количество ответов с кодами состояния «2xx».

3xx (integer)

Количество ответов с кодами состояния «3xx».

4xx (integer)

Количество ответов с кодами состояния «4xx».

5xx (integer)

Количество ответов с кодами состояния «5xx».

codes

Количество ответов для каждого кода состояния.

codeNumber (integer)

Количество ответов с этим конкретным кодом состояния.

total (integer)

Общее количество ответов, отправленных клиентам.

discarded (integer)

Общее количество запросов, обработанных без отправки ответа.

received (integer)

Общее количество байтов, полученных от клиентов.

sent (integer)

Общее количество байтов, отправленных клиентам.

ssl

handshakes (integer)

Общее количество успешных SSL-рукопожатий.

handshakes_failed (integer)

Общее количество неудачных SSL-рукопожатий.

session_reuses (integer)

Общее количество повторных использований сеансов во время SSL-рукопожатия.

no_common_protocol (integer)

Количество SSL-рукопожатий, завершившихся ошибкой из-за отсутствия общего протокола.

no_common_cipher (integer)

Количество SSL-рукопожатий, завершившихся ошибкой из-за отсутствия общего шифра.

handshake_timeout (integer)

Количество SSL-рукопожатий, завершившихся ошибкой из-за тайм-аута.

peer_rejected_cert (integer)

Количество неудачных SSL-рукопожатий, при которых nginx предъявил сертификат клиенту, но тот был отклонён с соответствующим сообщением alert.

verify_failures

Ошибки проверки SSL-сертификатов

no_cert (integer)

Клиент не предоставил требуемый сертификат.

expired_cert (integer)

Клиент предъявил просроченный или ещё не действующий сертификат.

revoked_cert (integer)

Клиент предъявил отозванный сертификат.

other (integer)

Другие ошибки проверки SSL-сертификатов.

Пример:
```
{
  "processing" : 1,
  "requests" : 706690,
  "responses" : {
    "1xx" : 0,
    "2xx" : 699482,
    "3xx" : 4522,
    "4xx" : 907,
    "5xx" : 266,
    "codes" : {
      "200" : 699482,
      "301" : 4522,
      "404" : 907,
      "503" : 266
    },
    "total" : 705177
  },
  "discarded" : 1513,
  "received" : 172711587,
  "sent" : 19415530115,
  "ssl" : {
    "handshakes" : 104303,
    "handshakes_failed" : 1421,
    "session_reuses" : 54645,
    "no_common_protocol" : 4,
    "no_common_cipher" : 2,
    "handshake_timeout" : 0,
    "peer_rejected_cert" : 0,
    "verify_failures" : {
      "no_cert" : 0,
      "expired_cert" : 2,
      "revoked_cert" : 1,
      "other" : 1
    }
  }
}
```
Зона HTTP-location:

requests (integer)

Общее количество запросов, полученных от клиентов.

responses

Общее количество ответов, отправленных клиентам, количество ответов с кодами состояния «1xx», «2xx», «3xx», «4xx» и «5xx», а также количество ответов для каждого кода состояния.

1xx (integer)

Количество ответов с кодами состояния «1xx».

2xx (integer)

Количество ответов с кодами состояния «2xx».

3xx (integer)

Количество ответов с кодами состояния «3xx».

4xx (integer)

Количество ответов с кодами состояния «4xx».

5xx (integer)

Количество ответов с кодами состояния «5xx».

codes

Количество ответов для каждого кода состояния.

codeNumber (integer)

Количество ответов с этим конкретным кодом состояния.

total (integer)

Общее количество ответов, отправленных клиентам.

discarded (integer)

Общее количество запросов, обработанных без отправки ответа.

received (integer)

Общее количество байтов, полученных от клиентов.

sent (integer)

Общее количество байтов, отправленных клиентам.

Пример:
```
{
  "requests" : 706690,
  "responses" : {
    "1xx" : 0,
    "2xx" : 699482,
    "3xx" : 4522,
    "4xx" : 907,
    "5xx" : 266,
    "codes" : {
      "200" : 112674,
      "301" : 4522,
      "404" : 2504,
      "503" : 266
    },
    "total" : 705177
  },
  "discarded" : 1513,
  "received" : 172711587,
  "sent" : 19415530115
}
```
HTTP-кэш:

size (integer)

Текущий размер кэша.

max_size (integer)

Указанное в конфигурации ограничение на максимальный размер кэша.

cold (boolean)

Логическое значение, указывающее, продолжает ли процесс «cache loader» загружать данные с диска в кэш.

hit

responses (integer)

Общее количество действительных ответов, прочитанных из кэша.

bytes (integer)

Общее количество байтов, прочитанных из кэша.

stale

responses (integer)

Общее количество просроченных ответов, прочитанных из кэша (см. proxy_cache_use_stale и другие директивы «*_cache_use_stale»).

bytes (integer)

Общее количество байтов, прочитанных из кэша.

updating

responses (integer)

Общее количество просроченных ответов, прочитанных из кэша во время обновления ответов (см. proxy_cache_use_stale и другие директивы «*_cache_use_stale»).

bytes (integer)

Общее количество байтов, прочитанных из кэша.

revalidated

responses (integer)

Общее количество просроченных и повторно проверенных ответов, прочитанных из кэша (см. proxy_cache_revalidate и другие директивы «*_cache_revalidate»).

bytes (integer)

Общее количество байтов, прочитанных из кэша.

miss

responses (integer)

Общее количество ответов, отсутствующих в кэше.

bytes (integer)

Общее количество байтов, прочитанных с проксируемого сервера.

responses_written (integer)

Общее количество ответов, записанных в кэш.

bytes_written (integer)

Общее количество байтов, записанных в кэш.

expired

responses (integer)

Общее количество просроченных ответов, не полученных из кэша.

bytes (integer)

Общее количество байтов, прочитанных с проксируемого сервера.

responses_written (integer)

Общее количество ответов, записанных в кэш.

bytes_written (integer)

Общее количество байтов, записанных в кэш.

bypass

responses (integer)

Общее количество ответов, для которых поиск в кэше не выполнялся из-за директивы proxy_cache_bypass и других директив «*_cache_bypass».

bytes (integer)

Общее количество байтов, прочитанных с проксируемого сервера.

responses_written (integer)

Общее количество ответов, записанных в кэш.

bytes_written (integer)

Общее количество байтов, записанных в кэш.

Пример:
```
{
  "size" : 530915328,
  "max_size" : 536870912,
  "cold" : false,
  "hit" : {
    "responses" : 254032,
    "bytes" : 6685627875
  },
  "stale" : {
    "responses" : 0,
    "bytes" : 0
  },
  "updating" : {
    "responses" : 0,
    "bytes" : 0
  },
  "revalidated" : {
    "responses" : 0,
    "bytes" : 0
  },
  "miss" : {
    "responses" : 1619201,
    "bytes" : 53841943822
  },
  "expired" : {
    "responses" : 45859,
    "bytes" : 1656847080,
    "responses_written" : 44992,
    "bytes_written" : 1641825173
  },
  "bypass" : {
    "responses" : 200187,
    "bytes" : 5510647548,
    "responses_written" : 200173,
    "bytes_written" : 44992
  }
}
```
Ограничение количества HTTP-соединений:

passed (integer)

Общее количество соединений, которые не были ни ограничены, ни учтены как ограниченные.

rejected (integer)

Общее количество отклонённых соединений.

rejected_dry_run (integer)

Общее количество соединений, учтённых как отклонённые в режиме пробного запуска.

Пример:
```
{
  "passed" : 15,
  "rejected" : 0,
  "rejected_dry_run" : 2
}
```
Ограничение частоты HTTP-запросов:

passed (integer)

Общее количество запросов, которые не были ни ограничены, ни учтены как ограниченные.

delayed (integer)

Общее количество задержанных запросов.

rejected (integer)

Общее количество отклонённых запросов.

delayed_dry_run (integer)

Общее количество запросов, учтённых как задержанные в режиме пробного запуска.

rejected_dry_run (integer)

Общее количество запросов, учтённых как отклонённые в режиме пробного запуска.

Пример:
```
{
  "passed" : 15,
  "delayed" : 4,
  "rejected" : 0,
  "delayed_dry_run" : 1,
  "rejected_dry_run" : 2
}
```
HTTP-upstream:

peers

Массив, содержащий:

id (integer)

Идентификатор сервера.

server (string)

Адрес сервера.

service (string)

Значение параметра service директивы server.

name (string)

Имя сервера, указанное в директиве server.

backup (boolean)

Логическое значение, указывающее, является ли сервер резервным.

weight (integer)

Вес сервера.

state (string)

Текущее состояние, которое может принимать значения «up», «draining», «down», «unavail», «checking» и «unhealthy».

active (integer)

Текущее количество активных соединений.

ssl

handshakes (integer)

Общее количество успешных SSL-рукопожатий.

handshakes_failed (integer)

Общее количество неудачных SSL-рукопожатий.

session_reuses (integer)

Общее количество повторных использований сеансов во время SSL-рукопожатия.

no_common_protocol (integer)

Количество SSL-рукопожатий, завершившихся ошибкой из-за отсутствия общего протокола.

handshake_timeout (integer)

Количество SSL-рукопожатий, завершившихся ошибкой из-за тайм-аута.

peer_rejected_cert (integer)

Количество неудачных SSL-рукопожатий, при которых nginx предъявил сертификат upstream-серверу, но тот был отклонён с соответствующим сообщением alert.

verify_failures

Ошибки проверки SSL-сертификатов

expired_cert (integer)

Upstream-сервер предъявил просроченный или ещё не действующий сертификат.

revoked_cert (integer)

Upstream-сервер предъявил отозванный сертификат.

hostname_mismatch (integer)

Сертификат сервера не соответствует имени узла.

other (integer)

Другие ошибки проверки SSL-сертификатов.

max_conns (integer)

Ограничение max_conns для сервера.

requests (integer)

Общее количество запросов клиентов, перенаправленных на этот сервер.

responses

1xx (integer)

Количество ответов с кодами состояния «1xx».

2xx (integer)

Количество ответов с кодами состояния «2xx».

3xx (integer)

Количество ответов с кодами состояния «3xx».

4xx (integer)

Количество ответов с кодами состояния «4xx».

5xx (integer)

Количество ответов с кодами состояния «5xx».

codes

Количество ответов для каждого кода состояния.

codeNumber (integer)

Количество ответов с этим конкретным кодом состояния.

total (integer)

Общее количество ответов, полученных от этого сервера.

sent (integer)

Общее количество байтов, отправленных этому серверу.

received (integer)

Общее количество байтов, полученных от этого сервера.

fails (integer)

Общее количество неудачных попыток установить связь с сервером.

unavail (integer)

Сколько раз сервер становился недоступен для запросов клиентов (состояние «unavail») из-за достижения порога max_fails по количеству неудачных попыток.

health_checks

checks (integer)

Общее количество выполненных запросов проверки работоспособности.

fails (integer)

Количество неудачных проверок работоспособности.

unhealthy (integer)

Сколько раз сервер переходил в неработоспособное состояние (состояние «unhealthy»).

last_passed (boolean)

Логическое значение, показывающее, была ли последняя проверка работоспособности успешной и пройдены ли тесты.

downtime (integer)

Общее время, в течение которого сервер находился в состояниях «unavail», «checking» и «unhealthy».

downstart (string)

Время перехода сервера в состояние «unavail», «checking» или «unhealthy» в формате ISO 8601 с точностью до миллисекунд.

selected (string)

Время, когда сервер в последний раз был выбран для обработки запроса, в формате ISO 8601 с точностью до миллисекунд.

header_time (integer)

Среднее время получения заголовка ответа от сервера.

response_time (integer)

Среднее время получения полного ответа от сервера.

response_time_hist

Гистограмма времени ответа upstream, собранная для каждого upstream-сервера.

count (integer)

Общее количество зарегистрированных ответов.

sum (integer)

Сумма времени всех зарегистрированных ответов upstream в миллисекундах.

buckets

Счётчики корзин гистограммы времени ответа upstream в миллисекундах. Имя каждой корзины («5», «10», «25», «50» и т. д.) обозначает предел времени в миллисекундах. Значение каждой корзины — это количество ответов, попавших в соответствующий временной интервал. В корзине «inf» учитываются ответы длительностью более 10000 мс.

5 (integer)

Общее количество ответов со временем ответа не более 5 мс.

10 (integer)

Общее количество ответов со временем ответа более 5 мс и не более 10 мс.

25 (integer)

Общее количество ответов со временем ответа более 10 мс и не более 25 мс.

50 (integer)

Общее количество ответов со временем ответа более 25 мс и не более 50 мс.

75 (integer)

Общее количество ответов со временем ответа более 50 мс и не более 75 мс.

100 (integer)

Общее количество ответов со временем ответа более 75 мс и не более 100 мс.

250 (integer)

Общее количество ответов со временем ответа более 100 мс и не более 250 мс.

500 (integer)

Общее количество ответов со временем ответа более 250 мс и не более 500 мс.

750 (integer)

Общее количество ответов со временем ответа более 500 мс и не более 750 мс.

1000 (integer)

Общее количество ответов со временем ответа более 750 мс и не более 1000 мс.

2500 (integer)

Общее количество ответов со временем ответа более 1000 мс и не более 2500 мс.

5000 (integer)

Общее количество ответов со временем ответа более 2500 мс и не более 5000 мс.

7500 (integer)

Общее количество ответов со временем ответа более 5000 мс и не более 7500 мс.

10000 (integer)

Общее количество ответов со временем ответа более 7500 мс и не более 10000 мс.

inf (integer)

Общее количество наблюдений со временем ответа более 10000 мс.

keepalive (integer)

Текущее количество простаивающих соединений keepalive.

zombies (integer)

Текущее количество серверов, удалённых из группы, но всё ещё обрабатывающих активные запросы клиентов.

zone (string)

Имя зоны разделяемой памяти, в которой хранятся конфигурация группы и состояние во время выполнения.

queue

Для очереди запросов предоставляются следующие данные:

size (integer)

Текущее количество запросов в очереди.

max_size (integer)

Максимальное количество запросов, которые могут одновременно находиться в очереди.

overflows (integer)

Общее количество запросов, отклонённых из-за переполнения очереди.

Пример:
```
{
  "upstream_backend" : {
    "peers" : [
      {
        "id" : 0,
        "server" : "10.0.0.1:8088",
        "name" : "10.0.0.1:8088",
        "backup" : false,
        "weight" : 5,
        "state" : "up",
        "active" : 0,
        "ssl" : {
          "handshakes" : 620311,
          "handshakes_failed" : 3432,
          "session_reuses" : 36442,
          "no_common_protocol" : 4,
          "handshake_timeout" : 0,
          "peer_rejected_cert" : 0,
          "verify_failures" : {
            "expired_cert" : 2,
            "revoked_cert" : 1,
            "hostname_mismatch" : 2,
            "other" : 1
          }
        },
        "max_conns" : 20,
        "requests" : 667231,
        "header_time" : 20,
        "response_time" : 36,
        "response_time_hist" : {
          "count" : 9817,
          "sum" : 57625,
          "buckets" : {
            "5" : 4428,
            "10" : 4755,
            "25" : 350,
            "50" : 235,
            "75" : 54,
            "100" : 47,
            "250" : 1,
            "500" : 0,
            "750" : 0,
            "1000" : 0,
            "2500" : 0,
            "5000" : 0,
            "7500" : 0,
            "10000" : 0,
            "inf" : 0
          }
        },
        "responses" : {
          "1xx" : 0,
          "2xx" : 666310,
          "3xx" : 0,
          "4xx" : 915,
          "5xx" : 6,
          "codes" : {
            "200" : 666310,
            "404" : 915,
            "503" : 6
          },
          "total" : 667231
        },
        "sent" : 251946292,
        "received" : 19222475454,
        "fails" : 0,
        "unavail" : 0,
        "health_checks" : {
          "checks" : 26214,
          "fails" : 0,
          "unhealthy" : 0,
          "last_passed" : true
        },
        "downtime" : 0,
        "downstart" : "2022-06-28T11:09:21.602Z",
        "selected" : "2022-06-28T15:01:25.000Z"
      },
      {
        "id" : 1,
        "server" : "10.0.0.1:8089",
        "name" : "10.0.0.1:8089",
        "backup" : true,
        "weight" : 1,
        "state" : "unhealthy",
        "active" : 0,
        "max_conns" : 20,
        "requests" : 0,
        "responses" : {
          "1xx" : 0,
          "2xx" : 0,
          "3xx" : 0,
          "4xx" : 0,
          "5xx" : 0,
          "codes" : {
          },
          "total" : 0
        },
        "sent" : 0,
        "received" : 0,
        "fails" : 0,
        "unavail" : 0,
        "health_checks" : {
          "checks" : 26284,
          "fails" : 26284,
          "unhealthy" : 1,
          "last_passed" : false
        },
        "downtime" : 262925617,
        "downstart" : "2022-06-28T11:09:21.602Z",
        "selected" : "2022-06-28T15:01:25.000Z"
      }
    ],
    "keepalive" : 0,
    "zombies" : 0,
    "zone" : "upstream_backend"
  }
}
```

Сервер HTTP upstream:
Динамически настраиваемые параметры сервера HTTP upstream:

id (integer)

Идентификатор сервера HTTP upstream. Идентификатор назначается автоматически и не может быть изменён.

server (string)

То же, что и параметр address сервера HTTP upstream. При добавлении сервера его можно указать как доменное имя. В этом случае изменения IP-адресов, соответствующих доменному имени, будут отслеживаться и автоматически применяться к конфигурации upstream без необходимости перезапускать nginx. Для этого требуется директива resolver в блоке «http». См. также параметр resolve сервера HTTP upstream.

service (string)

То же, что и параметр service сервера HTTP upstream. Этот параметр нельзя изменить.

weight (integer)

То же, что и параметр weight сервера HTTP upstream.

max_conns (integer)

То же, что и параметр max_conns сервера HTTP upstream.

max_fails (integer)

То же, что и параметр max_fails сервера HTTP upstream.

fail_timeout (string)

То же, что и параметр fail_timeout сервера HTTP upstream.

slow_start (string)

То же, что и параметр slow_start сервера HTTP upstream.

route (string)

То же, что и параметр route сервера HTTP upstream.

backup (boolean)

Если true, добавляет резервный сервер backup. Этот параметр нельзя изменить.

down (boolean)

То же, что и параметр down сервера HTTP upstream.

drain (boolean)

То же, что и параметр drain сервера HTTP upstream.

parent (string)

Идентификатор родительского сервера для разрешённого сервера. Идентификатор назначается автоматически и не может быть изменён.

host (string)

Имя хоста разрешённого сервера. Имя хоста назначается автоматически и не может быть изменено.

Пример:
```
{
  "id" : 1,
  "server" : "10.0.0.1:8089",
  "weight" : 4,
  "max_conns" : 0,
  "max_fails" : 0,
  "fail_timeout" : "10s",
  "slow_start" : "10s",
  "route" : "",
  "backup" : true,
  "down" : true
}
```
Зона разделяемой памяти HTTP keyval:
Содержимое зоны разделяемой памяти HTTP keyval при использовании метода GET.
Пример:
```
{
  "key1" : "value1",
  "key2" : "value2",
  "key3" : "value3"
}
```
Зона разделяемой памяти HTTP keyval:
Содержимое зоны разделяемой памяти HTTP keyval при использовании методов POST или PATCH.
Пример:
```
{
  "key1" : "value1",
  "key2" : "value2",
  "key3" : {
    "value" : "value3",
    "expire" : 30000
  }
}
```
Зона сервера Stream:

processing (integer)

Количество клиентских соединений, обрабатываемых в данный момент.

connections (integer)

Общее количество соединений, принятых от клиентов.

sessions

Общее количество завершённых сеансов и количество сеансов, завершённых с кодами состояния «2xx», «4xx» или «5xx».

2xx (integer)

Общее количество сеансов, завершённых с кодами состояния «2xx».

4xx (integer)

Общее количество сеансов, завершённых с кодами состояния «4xx».

5xx (integer)

Общее количество сеансов, завершённых с кодами состояния «5xx».

total (integer)

Общее количество завершённых клиентских сеансов.

discarded (integer)

Общее количество соединений, завершённых без создания сеанса.

received (integer)

Общее количество байтов, полученных от клиентов.

sent (integer)

Общее количество байтов, отправленных клиентам.

ssl

handshakes (integer)

Общее количество успешных рукопожатий SSL.

handshakes_failed (integer)

Общее количество неудачных рукопожатий SSL.

session_reuses (integer)

Общее количество повторных использований сеансов во время рукопожатия SSL.

no_common_protocol (integer)

Количество неудачных рукопожатий SSL из-за отсутствия общего протокола.

no_common_cipher (integer)

Количество неудачных рукопожатий SSL из-за отсутствия общего шифра.

handshake_timeout (integer)

Количество неудачных рукопожатий SSL из-за истечения времени ожидания.

peer_rejected_cert (integer)

Количество неудачных рукопожатий SSL, при которых nginx предъявил клиенту сертификат, но клиент отклонил его, отправив соответствующее предупреждение.

verify_failures

Ошибки проверки сертификата SSL

no_cert (integer)

Клиент не предоставил требуемый сертификат.

expired_cert (integer)

Клиент предоставил просроченный сертификат или сертификат, срок действия которого ещё не начался.

revoked_cert (integer)

Клиент предоставил отозванный сертификат.

other (integer)

Другие ошибки проверки сертификата SSL.

Пример:
```
{
  "dns" : {
    "processing" : 1,
    "connections" : 155569,
    "sessions" : {
      "2xx" : 155564,
      "4xx" : 0,
      "5xx" : 0,
      "total" : 155569
    },
    "discarded" : 0,
    "received" : 4200363,
    "sent" : 20489184,
    "ssl" : {
      "handshakes" : 76455,
      "handshakes_failed" : 432,
      "session_reuses" : 28770,
      "no_common_protocol" : 4,
      "no_common_cipher" : 2,
      "handshake_timeout" : 0,
      "peer_rejected_cert" : 0,
      "verify_failures" : {
        "no_cert" : 0,
        "expired_cert" : 2,
        "revoked_cert" : 1,
        "other" : 1
      }
    }
  }
}
```
Ограничение количества соединений Stream:

passed (integer)

Общее количество соединений, которые не были ограничены и не учитывались как ограниченные.

rejected (integer)

Общее количество отклонённых соединений.

rejected_dry_run (integer)

Общее количество соединений, учтённых как отклонённые в режиме пробного запуска.

Пример:
```
{
  "passed" : 15,
  "rejected" : 0,
  "rejected_dry_run" : 2
}
```
Stream upstream:

peers

Массив из:

id (integer)

Идентификатор сервера.

server (string)

Адрес сервера.

service (string)

Значение параметра service директивы server.

name (string)

Имя сервера, указанное в директиве server.

backup (boolean)

Логическое значение, указывающее, является ли сервер резервным сервером backup.

weight (integer)

Вес сервера.

state (string)

Текущее состояние: «up», «down», «unavail», «checking» или «unhealthy».

active (integer)

Текущее количество соединений.

ssl

handshakes (integer)

Общее количество успешных рукопожатий SSL.

handshakes_failed (integer)

Общее количество неудачных рукопожатий SSL.

session_reuses (integer)

Общее количество повторных использований сеансов во время рукопожатия SSL.

no_common_protocol (integer)

Количество неудачных рукопожатий SSL из-за отсутствия общего протокола.

handshake_timeout (integer)

Количество неудачных рукопожатий SSL из-за истечения времени ожидания.

peer_rejected_cert (integer)

Количество неудачных рукопожатий SSL, при которых nginx предъявил сертификат серверу upstream, но сервер отклонил его, отправив соответствующее предупреждение.

verify_failures

Ошибки проверки сертификата SSL

expired_cert (integer)

Сервер upstream предоставил просроченный сертификат или сертификат, срок действия которого ещё не начался.

revoked_cert (integer)

Сервер upstream предоставил отозванный сертификат.

hostname_mismatch (integer)

Сертификат сервера не соответствует имени хоста.

other (integer)

Другие ошибки проверки сертификата SSL.

max_conns (integer)

Ограничение max_conns для сервера.

connections (integer)

Общее количество клиентских соединений, перенаправленных на этот сервер.

connect_time (integer)

Среднее время подключения к серверу upstream.

first_byte_time (integer)

Среднее время получения первого байта данных.

response_time (integer)

Среднее время получения последнего байта данных.

sent (integer)

Общее количество байтов, отправленных этому серверу.

received (integer)

Общее количество байтов, полученных от этого сервера.

fails (integer)

Общее количество неудачных попыток связи с сервером.

unavail (integer)

Сколько раз сервер становился недоступным для клиентских соединений (состояние «unavail») из-за достижения порога max_fails по количеству неудачных попыток.

health_checks

checks (integer)

Общее количество выполненных запросов проверки работоспособности.

fails (integer)

Количество неудачных проверок работоспособности.

unhealthy (integer)

Сколько раз сервер становился неработоспособным (состояние «unhealthy»).

last_passed (boolean)

Логическое значение, указывающее, был ли последний запрос проверки работоспособности успешным и прошёл ли он тесты.

downtime (integer)

Общее время, в течение которого сервер находился в состояниях «unavail», «checking» и «unhealthy».

downstart (string)

Время перехода сервера в состояние «unavail», «checking» или «unhealthy» в формате ISO 8601 с точностью до миллисекунд.

selected (string)

Время, когда сервер в последний раз был выбран для обработки соединения, в формате ISO 8601 с точностью до миллисекунд.

zombies (integer)

Текущее количество серверов, удалённых из группы, но всё ещё обрабатывающих активные клиентские соединения.

zone (string)

Имя зоны разделяемой памяти, в которой хранятся конфигурация и состояние группы во время выполнения.

Пример:
```
{
  "dns" : {
    "peers" : [
      {
        "id" : 0,
        "server" : "10.0.0.1:12347",
        "name" : "10.0.0.1:12347",
        "backup" : false,
        "weight" : 5,
        "state" : "up",
        "active" : 0,
        "ssl" : {
          "handshakes" : 200,
          "handshakes_failed" : 4,
          "session_reuses" : 189,
          "no_common_protocol" : 4,
          "handshake_timeout" : 0,
          "peer_rejected_cert" : 0,
          "verify_failures" : {
            "expired_cert" : 2,
            "revoked_cert" : 1,
            "hostname_mismatch" : 2,
            "other" : 1
          }
        },
        "max_conns" : 50,
        "connections" : 667231,
        "sent" : 251946292,
        "received" : 19222475454,
        "fails" : 0,
        "unavail" : 0,
        "health_checks" : {
          "checks" : 26214,
          "fails" : 0,
          "unhealthy" : 0,
          "last_passed" : true
        },
        "downtime" : 0,
        "downstart" : "2022-06-28T11:09:21.602Z",
        "selected" : "2022-06-28T15:01:25.000Z"
      },
      {
        "id" : 1,
        "server" : "10.0.0.1:12348",
        "name" : "10.0.0.1:12348",
        "backup" : true,
        "weight" : 1,
        "state" : "unhealthy",
        "active" : 0,
        "max_conns" : 50,
        "connections" : 0,
        "sent" : 0,
        "received" : 0,
        "fails" : 0,
        "unavail" : 0,
        "health_checks" : {
          "checks" : 26284,
          "fails" : 26284,
          "unhealthy" : 1,
          "last_passed" : false
        },
        "downtime" : 262925617,
        "downstart" : "2022-06-28T11:09:21.602Z",
        "selected" : "2022-06-28T15:01:25.000Z"
      }
    ],
    "zombies" : 0,
    "zone" : "dns"
  }
}
```
Сервер Stream upstream:
Динамически настраиваемые параметры сервера Stream upstream:

id (integer)

Идентификатор сервера Stream upstream. Идентификатор назначается автоматически и не может быть изменён.

server (string)

То же, что и параметр address сервера Stream upstream. При добавлении сервера его можно указать как доменное имя. В этом случае изменения IP-адресов, соответствующих доменному имени, будут отслеживаться и автоматически применяться к конфигурации upstream без необходимости перезапускать nginx. Для этого требуется директива resolver в блоке «stream». См. также параметр resolve сервера Stream upstream.

service (string)

То же, что и параметр service сервера Stream upstream. Этот параметр нельзя изменить.

weight (integer)

То же, что и параметр weight сервера Stream upstream.

max_conns (integer)

То же, что и параметр max_conns сервера Stream upstream.

max_fails (integer)

То же, что и параметр max_fails сервера Stream upstream.

fail_timeout (string)

То же, что и параметр fail_timeout сервера Stream upstream.

slow_start (string)

То же, что и параметр slow_start сервера Stream upstream.

backup (boolean)

Если true, добавляет резервный сервер backup. Этот параметр нельзя изменить.

down (boolean)

То же, что и параметр down сервера Stream upstream.

parent (string)

Идентификатор родительского сервера для разрешённого сервера. Идентификатор назначается автоматически и не может быть изменён.

host (string)

Имя хоста разрешённого сервера. Имя хоста назначается автоматически и не может быть изменено.

Пример:
```
{
  "id" : 0,
  "server" : "10.0.0.1:12348",
  "weight" : 1,
  "max_conns" : 0,
  "max_fails" : 1,
  "fail_timeout" : "10s",
  "slow_start" : 0,
  "backup" : false,
  "down" : false
}
```
Зона разделяемой памяти Stream keyval:
Содержимое зоны разделяемой памяти Stream keyval при использовании метода GET.
Пример:
```
{
  "key1" : "value1",
  "key2" : "value2",
  "key3" : "value3"
}
```
Зона разделяемой памяти Stream keyval:
Содержимое зоны разделяемой памяти Stream keyval при использовании методов POST или PATCH.
Пример:
```
{
  "key1" : "value1",
  "key2" : "value2",
  "key3" : {
    "value" : "value3",
    "expire" : 30000
  }
}
```
Узел синхронизации зоны Stream:

zones

Информация о синхронизации для каждой зоны разделяемой памяти.

Коллекция объектов «Зона синхронизации»

status

Информация о синхронизации для каждого узла кластера.

bytes_in (integer)

Количество байтов, полученных этим узлом.

msgs_in (integer)

Количество сообщений, полученных этим узлом.

msgs_out (integer)

Количество сообщений, отправленных этим узлом.

bytes_out (integer)

Количество байтов, отправленных этим узлом.

nodes_online (integer)

Количество узлов, с которыми установлено соединение у этого узла.

Пример:
```
{
  "zones" : {
    "zone1" : {
      "records_pending" : 2061,
      "records_total" : 260575
    },
    "zone2" : {
      "records_pending" : 0,
      "records_total" : 14749
    }
  },
  "status" : {
    "bytes_in" : 1364923761,
    "msgs_in" : 337236,
    "msgs_out" : 346717,
    "bytes_out" : 1402765472,
    "nodes_online" : 15
  }
}
```
Зона синхронизации:
Состояние синхронизации зоны разделяемой памяти.

records_pending (integer)

Количество записей, которые необходимо отправить в кластер.

records_total (integer)

Общее количество записей, хранящихся в зоне разделяемой памяти.
Зона resolver:
Статистика DNS-запросов и ответов для конкретной зоны resolver.

requests

name (integer)

Общее количество запросов на преобразование имён в адреса.

srv (integer)

Общее количество запросов на разрешение записей SRV.

addr (integer)

Общее количество запросов на преобразование адресов в имена.

responses

noerror (integer)

Общее количество успешных ответов.

formerr (integer)

Общее количество ответов FORMERR (Format error).

servfail (integer)

Общее количество ответов SERVFAIL (Server failure).

nxdomain (integer)

Общее количество ответов NXDOMAIN (Host not found).

notimp (integer)

Общее количество ответов NOTIMP (Unimplemented).

refused (integer)

Общее количество ответов REFUSED (Operation refused).

timedout (integer)

Общее количество запросов, время ожидания которых истекло.

unknown (integer)

Общее количество запросов, завершившихся неизвестной ошибкой.

Пример:
```
{
  "resolver_zone1" : {
    "requests" : {
      "name" : 25460,
      "srv" : 130,
      "addr" : 2580
    },
    "responses" : {
      "noerror" : 26499,
      "formerr" : 0,
      "servfail" : 3,
      "nxdomain" : 0,
      "notimp" : 0,
      "refused" : 0,
      "timedout" : 243,
      "unknown" : 478
    }
  }
}
```
Лицензия:
Сведения о состоянии лицензии и отчётности об использовании экземпляра NGINX Plus.

eval (boolean)

Указывает, является ли лицензия NGINX Plus пробной.

active_till (integer)

Временная метка Unix истечения срока действия лицензии.

reporting

healthy (boolean)

Указывает, считается ли состояние отчётности нормальным, несмотря на недавние неудачные попытки.

fails (integer)

Количество неудачных попыток отправки отчёта; сбрасывается после каждой успешной отправки отчёта об использовании.

grace (integer)

Количество секунд до прекращения обработки трафика после неудачной попытки отправить отчёт.

uuid (string)

Идентификатор экземпляра NGINX Plus в формате UUID.

Пример:
```
{
  "eval" : false,
  "active_till" : 1749268757,
  "reporting" : {
    "healthy" : true,
    "fails" : 2,
    "grace" : 15551961,
    "uuid" : "13754cba-29fb-53e5-c32e-a6cf57c84b01"
  }
}
```
Рабочий процесс:
Статистика для каждого рабочего процесса.

id (integer)

Идентификатор рабочего процесса.

pid (integer)

Идентификатор PID рабочего процесса, используемый операционной системой.

connections

Количество принятых, сброшенных, активных и простаивающих соединений для каждого рабочего процесса.

accepted (integer)

Общее количество клиентских соединений, принятых рабочим процессом.

dropped (integer)

Общее количество клиентских соединений, сброшенных рабочим процессом.

active (integer)

Текущее количество активных клиентских соединений, обрабатываемых рабочим процессом.

idle (integer)

Количество простаивающих клиентских соединений, обрабатываемых в данный момент рабочим процессом.

http

requests

Общее количество клиентских запросов, обработанных рабочим процессом.

total (integer)

Общее количество клиентских запросов, полученных рабочим процессом.

current (integer)

Текущее количество клиентских запросов, обрабатываемых рабочим процессом.

Пример:
```
{
  "id" : 0,
  "pid" : 32212,
  "connections" : {
    "accepted" : 1,
    "dropped" : 0,
    "active" : 1,
    "idle" : 0
  },
  "http" : {
    "requests" : {
      "total" : 15,
      "current" : 1
    }
  }
}
```
Ошибка:
Объект ошибки nginx.

error

status (integer)

Код ошибки HTTP.

text (string)

Описание ошибки.

code (string)

Внутренний код ошибки nginx.

request_id (string)

Идентификатор запроса, совпадающий со значением переменной $request_id.

href (string)

Ссылка на справочную документацию.

© 2002-2021 Igor Sysoev
© 2011-2026 Nginx, Inc.
Licensed under the BSD License.
https://nginx.org/en/docs/http/ngx_http_api_module.html