Управление конфигурациями
/services/configurationservice/api/config/get
Получить информацию о заданной версии конфигурации для сервиса
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация о конфиге
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет | |
| configVersion | string | Версия конфигурации | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Конфигурация сервиса (без подстановок)
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ConfigInfo | |||
| error | Info |
/services/configurationservice/api/config/set
Сохранить изменения по конфигурации сервиса
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Конфигурация сервиса
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| settings | ConfSetting[] | Список конфигурационных параметров | нет | |
| serviceName | string | Имя сервиса | нет | |
| description | string | Описание конфигурации | нет | |
| version | string | Версия конфигурации | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
/services/configurationservice/api/config/delete
Удалить заданную версию конфигурации для сервиса
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация о конфиге
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет | |
| configVersion | string | Версия конфигурации | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/configurationservice/api/config/clear
Удалить все конфигурации для сервиса
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация о сервисе
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/configurationservice/api/config/load
Загрузить обработанную и готовую к работе конфигурацию сервиса
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация о ноде сервиса, для которо го загружается конфигурация
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет | |
| configVersion | string | Версия конфигурации | нет | |
| nodeId | string | Идентификатор ноды, которая запрашивает конфигурацию | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Получение окончательной конфигурации сервиса (со всеми подстановками)
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | Результат метода API. | нет | |
| error | Info |
/services/configurationservice/api/config/list
Получить список доступных конфигураций для данного сервиса
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Информация о сервисе
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Получения списка конфигураций для сервиса
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ConfigItem[] | Результат метода API. | нет | |
| error | Info |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
/services/configurationservice/api/config/global
Получить список сервисов, описывающих конфигурацию
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Список сервисов с типом "Конфигурация"
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | GlobalConfigItem[] | Результат метода API. | нет | |
| error | Info |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden