/config

Содержание раздела

URL
Заголовки запроса
1. [ x-request-id ]
Тело запроса
Примеры cURL-запросов

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

Доступные фильтры поиска:

частичный или полный путь до параметра;
частичное или полное имя переменной окружения.

Если заданный фильтр является частью пути или имени переменной нескольких параметров, возвращаются все совпадения. При полном совпадении возвращается только оно — частичные совпадения не ищутся. При отсутствии фильтра возвращаются все параметры.

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

URL

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

Параметры:

baseUrl — адрес ноды Prostore, состоящий из IP-адреса или доменного имени и номера порта;
filter_string — строковый фильтр поиска в любом регистре, который может быть:
- частичным или полным именем соответствующей переменной окружения;
- частичным или полным путем до параметра.
Вложенные элементы пути перечисляются через %3A (двоеточие в кодировке для HTTP).

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

[ x-request-id ]

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

Тело запроса

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

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

Запрос с полным путем до параметра

Запрос параметра poolSize датасорса adp2* с указанием полного пути до этого параметра:

curl -X 'GET' \
  'http://localhost:9090/api/v1/config?parameterName=adp%3Adatasource[1]%3ApoolSize' \
  -H 'x-request-id: 9a873856-635e-4571-83ad-f480db169552'

* В примере adp2 имеет порядковый номер 1: он был добавлен вторым среди ADP-датасорсов (нумерация с 0). При изменении состава хранилища номера датасорсов могут меняться.

Запрос с частичным путем до параметра

Запрос всех параметров датасорса adp2 (номер датасорса в квадратных скобках может меняться при изменении состава хранилища):

curl -X 'GET' \
  'http://localhost:9090/api/v1/config?parameterName=adp%3Adatasource[1]' \
  -H 'x-request-id: e9cda84b-098d-408e-ba35-7a9fd911dd12'

Запрос с полным именем переменной окружения

Запрос параметров с переменной adp_port:

curl -X 'GET' \
  'http://localhost:9090/api/v1/config?parameterName=adp_port' \
  -H 'x-request-id: 93a1338f-b6f0-4517-88c3-43f6dea5e2b8'

Запрос с частичным именем переменной окружения

Запрос параметров с переменной, имя которой содержит строку adp2_:

curl -X 'GET' \
  'http://localhost:9090/api/v1/config?parameterName=adp2_' \
  -H 'x-request-id: aec8ae8a-d5ce-4dde-bd0f-403916a06fa8'

Запрос информации обо всех параметрах

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