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

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

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

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

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

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

Группа node:

GET /node/config

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

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

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

GET /node/config:
{
    {
      "version": "1.3.0-RC7",
      "gostCrypto": false,
      "chainId": "V",
      "consensus": "POA",
      "minimumFee": {
          "3": 0,
          "4": 0,
          "5": 0,
          "6": 0,
          "7": 0,
          "8": 0,
          "9": 0,
          "10": 0,
          "11": 0,
          "12": 0,
          "13": 0,
          "14": 0,
          "15": 0,
          "102": 0,
          "103": 0,
          "104": 0,
          "106": 0,
          "107": 0,
          "111": 0,
          "112": 0,
          "113": 0,
          "114": 0
      },
      "additionalFee": {
          "11": 0,
          "12": 0
      },
      "maxTransactionsInMicroBlock": 500,
      "minMicroBlockAge": 0,
      "microBlockInterval": 1000,
      "blockTiming": {
          "roundDuration": 7000,
          "syncDuration": 700
    }
}

GET /node/owner

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

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

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

GET /node/config:
{
  "address": "3JFR1pmL6biTzr9oa63gJcjZ8ih429KD3aF",
  "publicKey": "EPxkVA9iQejsjQikovyxkkY8iHnbXsR3wjgkgE7ZW1Tt"
}

GET /node/status

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

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

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

GET /node/status:
{
    "blockchainHeight": 47041,
    "stateHeight": 47041,
    "updatedTimestamp": 1544709501138,
    "updatedDate": "2018-12-13T13:58:21.138Z"
}

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

GET /node/status:
{
    "error": 199,
    "message": "Environment check failed: Supported JCSP version is 5.0.40424, actual is 2.0.40424"
}

GET /node/version

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

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

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

GET /node/version:
{
  "version": "Waves Enterprise v0.9.0"
}

GET /node​/logging

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

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

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

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

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

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

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

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

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

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

GET /node​/logging:
ROOT-DEBUG
akka-DEBUG
akka.actor-DEBUG
akka.actor.ActorSystemImpl-DEBUG
akka.event-DEBUG
akka.event.slf4j-DEBUG
akka.event.slf4j.Slf4jLogger-DEBUG
com-DEBUG
com.github-DEBUG
com.github.dockerjava-DEBUG
com.github.dockerjava.core-DEBUG
com.github.dockerjava.core.command-DEBUG
com.github.dockerjava.core.command.AbstrDockerCmd-DEBUG
com.github.dockerjava.core.exec-DEBUG

POST /node​/logging

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

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

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

POST /node​/logging:
{
    "logger": "com.wavesplatform.Application",
    "level": "ALL"
}

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 конфигурационного файла ноды.

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

GET /anchoring/config:
{
 "enabled": true,
 "currentChainOwnerAddress": "3FWwx4o1177A4oeHAEW5EQ6Bkn4Lv48quYz",
 "mainnetNodeAddress": "https://clinton-pool.wavesenterpriseservices.com:443",
 "mainnetSchemeByte": "L",
 "mainnetRecipientAddress": "3JzVWCSV6v4ucSxtGSjZsvdiCT1FAzwpqrP",
 "mainnetFee": 8000000,
 "currentChainFee": 666666,
 "heightRange": 5,
 "heightAbove": 3,
 "threshold": 10
}
Смотрите также

Методы REST API

Примеры конфигурационных файлов ноды