Установка и использование платформы

REST API: информация о конфигурации и состоянии ноды, остановка ноды

Для получения информации о конфигурации ноды предусмотрены две группы методов:

  • node – получение основных конфигурационных параметров ноды, информации о состоянии ноды, остановка ноды, изменение уровня логирования;

  • anchoring – запрос GET /anchoring/config, возвращающий секцию anchoring конфигурационного файла ноды.

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

Примечание

Те же данные, что и с помощью REST методов группы node можно получить с помощью gRPC методов NodeConfig и NodeOwner.

Группа node:

GET /node/config

https://img.shields.io/badge/auth-required-orange.svg

Метод возвращает основные конфигурационные параметры ноды.

Пример ответа:

Примечание

Те же данные, что и с помощью метода GET /node/config можно получить с помощью gRPC метода NodeConfig.

GET /node/owner

https://img.shields.io/badge/auth-required-orange.svg

Метод возвращает адрес и публичный ключ владельца ноды.

Пример ответа:

Примечание

Те же данные, что и с помощью метода GET /node/owner, можно получить с помощью gRPC метода NodeOwner.

GET /node/status

https://img.shields.io/badge/auth-no-brightgreen.svg

Метод возвращает информацию о текущем состоянии ноды.

Пример ответа:

Также, при возникновении ошибок с использованием ГОСТ-криптографии на ноде, метод вернет описание ошибки:

GET /node/version

https://img.shields.io/badge/auth-no-brightgreen.svg

Метод возвращает версию ноды.

Пример ответа:

GET /node​/logging

https://img.shields.io/badge/auth-required-orange.svg

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

Уровни логирования ноды:

  • ERROR – логирование ошибок;

  • WARN – логирование предупреждений;

  • INFO – логирование событий ноды;

  • DEBUG – расширенная информация о событиях по каждому работающему модулю ноды: запись произошедших событий и выполняемых действий;

  • TRACE – подробная информация о событиях уровня DEBUG;

  • ALL – отображение информации на всех уровнях логирования.

Пример ответа:

GET /node/healthcheck

https://img.shields.io/badge/auth-no-brightgreen.svg

Метод производит проверку доступности внешнего сервиса, указанного в запросе. В запросе должен быть указан параметр service, который может принимать одно из следующих значений:

  • docker;

  • privacy-storage;

  • anchoring-auth.

По умолчанию используется значение docker.

Метод возвращает значение 200 ОК и пустой ответ, если проверка прошла успешно, иначе – 503 Service Unavailable и описание ошибки. Если один из внешних сервисов не настроен (на ноде отключена функциональность докер смарт контрактов, отключена настройка групп доступа к конфиденциальным данным, отключен анкоринг), метод возвращает ошибку 404 Not Found с сообщением о том, что определенная настройка отключена.

POST /node​/logging

https://img.shields.io/badge/auth-required-orange.svg

Метод предназначен для смены уровня логирования для выбранных логгеров. Уровни логирования ноды перечислены и описаны в разделе GET /node​/logging.

Пример запроса:

POST /node/stop

https://img.shields.io/badge/auth-required-orange.svg

Метод останавливает ноду, ответа не предусмотрено.

Важно

Метод POST /node/stop недоступен при использовании PKI, то есть когда в конфигурационном файле ноды параметру node.crypto.pki.mode присвоено значение ON. В тестовом режиме PKI (node.crypto.pki.mode = TEST) или при отключенном PKI (node.crypto.pki.mode = OFF) метод можно использовать.

Группа anchoring:

GET /anchoring/config

https://img.shields.io/badge/auth-required-orange.svg

Метод выводит секцию anchoring конфигурационного файла ноды.

Пример ответа: