/config

Содержание раздела
  1. URL
  2. Заголовки запроса
    1. [ x-request-id ]
  3. Тело запроса
  4. Примеры cURL-запросов

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

Альтернативно конфигурацию можно запросить с помощью CONFIG_SHOW.

URL

{baseUrl}/api/v1/config[?parameterName={parameter}]

Параметры:

  • baseUrl — адрес ноды Prostore, состоящий из IP-адреса или доменного имени и номера порта;

  • parameter — полный путь к параметру конфигурации или имя соответствующей переменной окружения.

    Путь к параметру включает все уровни вложенности, разделенные последовательностью %3A (двоеточие в кодировке для HTTP). Пример: core%3Araft%3AheartbeatPeriod.

    Имя переменной задается как задано в конфигурации. Пример: RAFT_HEARTBEAT_PERIOD_MS.

Заголовки запроса

[ x-request-id ]

Задает уникальный идентификатор HTTP-запроса. Если не указан, система генерирует UUID-значение и возвращает его в качестве идентификатора в ответе.

Тело запроса

Тело запроса отсутствует.

Примеры cURL-запросов

Запрос всех параметров конфигурации:

curl -X 'GET' \
  'http://localhost:9090/api/v1/config' \
  -H 'x-request-id: 6679cdd8-91fe-40d8-ba15-d093fd5e9735'

Запрос одного параметра с указанием полного пути core:raft:servicedb:schema:

curl -X 'GET' \
  'http://localhost:9090/api/v1/config?core%3Araft%3Aservicedb%3Aschema' \
  -H 'x-request-id: 9a873856-635e-4571-83ad-f480db169552'

Запрос одного параметра с указанием переменной окружения RAFT_SERVICEDB_SCHEMA:

curl -X 'GET' \
  'http://localhost:9090/api/v1/config?RAFT_SERVICEDB_SCHEMA' \
  -H 'x-request-id: 86aaa0fb-c2e2-480a-a886-59837b03f951'