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

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

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

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

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

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

Группа node:

GET /node/config

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

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

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

GET /node/owner

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

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

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

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 - отображение информации на всех уровнях логирования.

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

POST /node​/logging

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

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

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

POST /node/stop

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

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

Метод GET /anchoring/config:

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

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

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