Управление конфигурацией discovery, сервисов и их узлов.
/api/Config/get
Получить конфигурацию сервиса Discovery.
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | DiscoveryConfiguration | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/Discovery public ConfigController GetV1ConfigDiscoveryPost()
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | discovery:config:read |
/components/securitySchemes/Discovery
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | discovery:dashboard:read, discovery:service:read, discovery:service:write |
/api/Config/SetV1
Сохранить информацию для сервиса Discovery.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель конфигурации сервиса Discovery.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| periodPing | integer (int32) | Период пингования нод | нет | |
| nodeAutoApprove | boolean | Признак того, что новь зарегистрированные ноды надо автоматически апрувить | нет | |
| allowedNetworks | 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
Схемы авторизации
/components/securitySchemes/Discovery public ConfigController SetV1ConfigDiscovery(ASE.MD.Platform.Infrastructure.Discovery.Models.Config.DiscoveryConfiguration)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | discovery:config:write |
/components/securitySchemes/Discovery
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | discovery:dashboard:read, discovery:service:read, discovery:service:write |
/api/Config/GetServiceVersionDefault
Возвращает конфигурацию по умолчанию (MDSettings) для заданной версии сервиса.
Принимает модель, содержащую имя сервиса и его версию и возвращает модель, содержащую имя имя сервиса, версию и список элементов конфигурации по умолчанию.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель, содержащая имя сервиса и его версию.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет | |
| serviceVersion | string | Версия сервиса | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ServiceVersionDefaultConfig | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
/api/Config/GetServiceDefault
Возвращает конфигурацию по умолчанию (MDSettings) для всех версий сервиса.
Принимает модель, содержащую имя сервиса и возвращает модель, содержащую имя сервиса, и словарь ключ-значение, где ключ - версия, а значение - модель конфигурации по умолчанию.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель, содержащую имя сервиса.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ServiceDefaultConfigs | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |