Модуль 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
/workers/
/workers/{workerId}
Объекты ответов

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

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

При использовании методов PATCH или POST, убедитесь, что загрузка не превышает размер буфера для чтения тела запроса клиента, иначе может быть возвращено сообщение об ошибке 413 (Request Entity Too Large).

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

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

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 в окружающем месте расположения. Доступ к этому месту должен быть ограничен.

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

Все запросы API должны содержать поддерживаемую версию API в URI. Если адрес URI запроса равен префиксу расположения, возвращается список поддерживаемых версий 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, если во время обработки запроса происходит внутренний переадресации.

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

Данные /workers/ были добавлены в версии 9.
Подробные счетчики ошибок были добавлены в SSL-статистику в версии 8 (1.23.2).
Данные ssl для каждого HTTP upstream, серверной зоны и stream upstream, серверной зоны были добавлены в версии 8 (1.21.6).
Данные codes в responses для каждого HTTP upstream, серверной зоны и зоны расположения были добавлены в версии 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 - Возвращает состояние всех слоёв
Возвращает состояние слоёв для каждой зоны общей памяти с аллокатором слоёв.

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

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

Ограничивает, какие поля зон слоёв будут выведены. Если значение “fields” пустое, то выводятся только имена зон.

Возможные ответы:
- 200 - Успех, возвращает набор объектов "Зона общей памяти с аллокатором слоёв" для всех слоёв
- 404 - Неизвестная версия (UnknownVersion), возвращает Ошибка

/slabs/{slabZoneName}

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

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

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

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

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

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

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

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

Возможные ответы:
- 204 - Успех
- 404 - Слой не найден (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 location zone.

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

GET - Возвращает состояние зоны расположения HTTP
Возвращает состояние конкретной зоны расположения HTTP location zone.

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

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

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

Возможные ответы:
- 200 - Успех, возвращает HTTP Location Zone
- 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
Возвращает статус информации для каждой HTTP limit_conn зоны.

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

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

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

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

/http/limit_conns/{httpLimitConnZoneName}

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

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

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

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

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

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

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

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

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

/http/limit_reqs/

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

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

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

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

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

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

/http/limit_reqs/{httpLimitReqZoneName}

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

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

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

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

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

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

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

Возможные ответы:
- 200 - Успех, возвращает Ограничение скорости запросов
- 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 в группе серверов 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), у upstream сервиса “host” может отсутствовать порт (UpstreamBadAddress), 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), неверный ID сервера (UpstreamBadServerId), возвращает Ошибка
- 404 - Сервера с ID “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), неверный ID сервера (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 “id” не существует (UpstreamServerNotFound), неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает Ошибка
- 405 - Метод отключен (MethodDisabled), возвращает Ошибка
- 415 - Ошибка JSON (JsonError), возвращает Ошибка
DELETE - Удаление сервера из группы серверов HTTP upstream
Удаляет сервер из группы серверов HTTP upstream.

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

/http/keyvals/

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

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

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

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 - Возврат состояния всех зон limit_conn потока
Возвращает информацию о состоянии каждой зоны limit_conn потока.

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

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

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

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

/stream/limit_conns/{streamLimitConnZoneName}

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

streamLimitConnZoneName (string, требуется): Имя зоны limit_conn.

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

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

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

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

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

Возможные ответы:
- 200 - Успешно, возвращает Ограничение подключений потока
- 404 - limit_conn не найден (LimitConnNotFound), неизвестная версия (UnknownVersion), возвращает Ошибка
DELETE - Сброс статистики для зоны 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 “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 “id” не существует (UpstreamServerNotFound), неизвестная версия (UnknownVersion), upstream не найден (UpstreamNotFound), возвращает Ошибка
- 405 - Метод отключен (MethodDisabled), возвращает Ошибка
- 415 - Ошибка JSON (JsonError), возвращает Ошибка
DELETE - Удаление сервера из группы серверов потокового upstream
Удаляет сервер из группы серверов потока.

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

/stream/keyvals/

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

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

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

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

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

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

/stream/keyvals/{streamKeyvalZoneName}

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

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

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

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

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

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

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

Возможные ответы:
- 200 - Успех, возвращает Зону общей памяти Stream Keyval
- 404 - Ключ keyval не найден (KeyvalNotFound), ключ key не найден (KeyvalKeyNotFound), неизвестная версия (UnknownVersion), возвращает Ошибка
POST - Добавляет пару ключ-значение в зону stream keyval
Добавляет новую пару ключ-значение в зону общей памяти stream keyval zone. Если зона 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 - Request Entity Too Large, возвращает Ошибка
- 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), ключ key не найден (KeyvalKeyNotFound), неизвестная версия (UnknownVersion), возвращает Ошибка
- 405 - Метод отключен (MethodDisabled), возвращает Ошибка
- 413 - Request Entity Too Large, возвращает Ошибка
- 415 - Ошибка JSON (JsonError), возвращает Ошибка
DELETE - Очищает зону stream keyval
Удаляет все пары ключ-значение из зоны общей памяти stream keyval zone. Если синхронизация зон keyval в кластере включена, очищает зону keyval только на целевом узле кластера.

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

/stream/zone_sync/

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

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

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

/resolvers/

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

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

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

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

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

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

/resolvers/{resolverZoneName}

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

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

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

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

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

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

Ограничивает, какие поля зоны resolver будут выведены (запросы, ответы или оба).

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

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

/ssl

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

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

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

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

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

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

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

/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 представил сертификат клиенту, но он был отклонен с соответствующим сообщением об ошибке.

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
  }
}
```
Общий сектор памяти с выделением памяти по блокам:
Общий сектор памяти с выделением памяти по блокам

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 представил сертификат клиенту, но он был отклонен с соответствующим сообщением об ошибке.

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:

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)

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

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)

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

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 представил сертификат серверу-прокси, но он был отклонен с соответствующим сообщением об ошибке.

verify_failures

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

expired_cert (integer)

Сервером-прокси был представлен просроченный или еще не действительный сертификат.

revoked_cert (integer)

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

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)

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

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 header) от сервера.

response_time (integer)

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

keepalive (integer)

Текущее количество неиспользуемых подключений keepalive.

zombies (integer)

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

zone (string)

Имя зоны общей памяти zone, хранящей конфигурацию и текущее состояние группы.

queue

Для очереди запросов 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,
        "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
  }
}
```
Зона сервера потоков:

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
      }
    }
  }
}
```
Ограничение соединений потоков:

passed (integer)

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

rejected (integer)

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

rejected_dry_run (integer)

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

Пример:
```
{
  "passed" : 15,
  "rejected" : 0,
  "rejected_dry_run" : 2
}
```
Поток Вверх по течению:

peers

Массив из:

id (integer)

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

server (string)

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

service (string)

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

name (string)

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

backup (boolean)

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

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 представил сертификат серверу, но он был отклонен с соответствующим сообщением об ошибке.

verify_failures

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

expired_cert (integer)

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

revoked_cert (integer)

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

hostname_mismatch (integer)

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

other (integer)

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

max_conns (integer)

Предел max_conns для сервера.

connections (integer)

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

connect_time (integer)

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

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"
  }
}
```

Сервер потокового соединения:
Динамически настраиваемые параметры сервера потокового соединения server:

id (integer)

Идентификатор сервера потокового соединения. Идентификатор назначается автоматически и изменить его нельзя.

server (string)

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

service (string)

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

weight (integer)

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

max_conns (integer)

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

max_fails (integer)

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

fail_timeout (string)

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

slow_start (string)

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

backup (boolean)

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

down (boolean)

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

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 Zone:

zones

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

Коллекция объектов "Sync Zone"

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)

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

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
    }
  }
}
```
Процесс worker:
Статистика для каждого процесса worker.

id (integer)

Идентификатор процесса worker.

pid (integer)

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

connections

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

accepted (integer)

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

dropped (integer)

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

active (integer)

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

idle (integer)

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

http

requests

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

total (integer)

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

current (integer)

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

Пример:
```
{
  "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-2024 Nginx, Inc.
Licensed under the BSD License.
https://nginx.org/en/docs/http/ngx_http_api_module.html