Типы данных
ASE.MD.Platform.Base.Error.ErrorTypes
Базовый тип перечисления: string Возможные значения: None, Error, Auth, Exception
ASE.MD.Platform.Base.Error.Info
Ти п: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Сообщение ошибки. | да | |
| exceptionType | string | Тип исключения. | да | |
| code | string | Код ошибки. | да | |
| source | string | Имя источника. | да | |
| inners | InnerInfo[] | Элементы исключений. | да | |
| extra | string | Трейс стека. | да | |
| isError | boolean | Флаг ошибки. | да | |
| id | string | Идентификатор ошибки. | да | |
| type | ErrorTypes | да |
ASE.MD.Platform.Base.Error.InnerInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| exceptionType | string | Тип исключения. | нет | |
| message | string | Сообщение исключения. | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Config.DiscoveryConfiguration
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| periodPing | integer (int32) | Период пингования нод | нет | |
| nodeAutoApprove | boolean | Признак того, что новь зарегистрированные ноды надо автоматически апрувить | нет | |
| allowedNetworks | string[] | Список сетей из которых разрешается регистрировать ноды | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Config.DiscoveryConfigurationApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | DiscoveryConfiguration | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Config.ServiceDefaultConfigs
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет | |
| versionSettings | object | Список default настроек для каждого сервиса | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Config.ServiceDefaultConfigsApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ServiceDefaultConfigs | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Config.ServiceVersionDefaultConfig
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет | |
| serviceVersion | string | Версия сервиса | нет | |
| settings | DefaultConfigurationSetting[] | Список default настроек | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Config.ServiceVersionDefaultConfigApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ServiceVersionDefaultConfig | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.ConfigSettingDetail
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| key | string | Ключ параметра | нет | |
| value | string | Значение параметра | нет | |
| source | string | Источник, в котором задан данный параметр | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.DashboardApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | DashboardInfo | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.DashboardInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| services | DashboardServiceInfo[] | Список информации по сервисам | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.DashboardServiceInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможны е значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет | |
| serviceType | Type | |||
| activeNodes | string[] | Спискок идентификаторов активных нод | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.DefaultConfigurationSetting
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| key | string | нет | ||
| value | string | нет | ||
| description | string | нет | ||
| type | DefaultSettingTypes | |||
| regexp | string | нет | ||
| allowedValues | string[] | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.DefaultSettingTypes
Базовый тип перечисления: string Возможные значения: Bool, Int, String
ASE.MD.Platform.Infrastructure.Discovery.Models.NodeDetailConfigApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ConfigSettingDetail[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.NodeIdentifier
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nodeUid | string | Идентификатор ноды | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.NodeStatusParameter
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| status | Status | |||
| nodeUid | string | Идентификатор ноды | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Ping.Command
Базовый тип перечисления: string Возможные значения: None, Stop, NeedRegistration, NeedSendConfig, ReloadNginxConfig, ReloadServiceConfig, WaitConfiguration, NeedSendDefaultConfig
ASE.MD.Platform.Infrastructure.Discovery.Models.Ping.ExternalPingInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nodeId | string | Идентификатор ноды, которая послала пинг | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Ping.PingApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Command | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Ping.PingInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nodeId | string | Идентификатор ноды, которая послала пинг | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Ping.PingInfoApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Во зможные значения |
|---|---|---|---|---|
| result | PingInfoResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Ping.PingInfoResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| command | Command | |||
| context | object | Данные (контекст) для выполнения команды | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Results.AdminNodeInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| protocolType | ProtocolTypes | |||
| scheme | string | Схема запроса | нет | |
| ip | string | IP адрес | нет | |
| port | integer (int32) | Network port | нет | |
| status | Status | |||
| id | string | Идентификатор ноды | нет | |
| version | string | Версия сервиса | нет | |
| configVersion | string | Версия конфигурации | нет | |
| apiVersion | string | Версия api | нет | |
| dbVersion | string | версия БД | нет | |
| isOnline | boolean | Признак того, что нода является рабочей | нет | |
| skills | string[] | Список скилов, реализуемых сервисом ноды | нет | |
| lastPing | string (date-time) | Время последнего пингования ноды | нет | |
| metricPath | string | Путь до endpoint метрик | нет | |
| metricPortScheme | PortScheme | |||
| metricPort | integer (int32) | Порт выдачи метрик | нет | |
| languageUsed | string | Язык на каком написан сервис | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Results.AdminNodesListApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | AdminNodeInfo[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Info
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | string | ID service | нет | |
| name | string | Name service | нет | |
| description | string | Description service | нет | |
| title | string | Title service | нет | |
| version | object | Список нод этого сервиса с их версиями | нет | |
| skills | object | Список нод этого сервиса с их скилами | нет | |
| online | object | Список Online нод | нет | |
| countAll | integer (int32) | Общее число нод, зарегистрированных для сервиса | нет | |
| countOnline | integer (int32) | Число активных нод | нет | |
| countNotApprove | integer (int32) | нет | ||
| type | Type | |||
| syncToNginx | boolean | Признак синхронизации с Nginx | нет | |
| useNginxWorkStatus | boolean | нет | ||
| isSystem | boolean | Признак системного сервиса | нет | |
| hasMdSettings | boolean | Флаг наличия настроек MDSettings | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.InfoResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Info | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Install
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя сервиса | нет | |
| description | string | Полное описание сервиса | нет | |
| title | string | Краткое описание сервиса | нет | |
| type | Type | |||
| syncToNginx | boolean | Признак того, что ноды сервиса должны синхронизироваться с nginx | нет | |
| useNginxWorkStatus | boolean | нет | ||
| isSystem | boolean | Признак системного сервиса | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.InstallResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.ListResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Info[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.ExternalRegistration
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| metricPath | string | нет | ||
| metricPortScheme | PortScheme | |||
| metricPort | integer (int32) | нет | ||
| languageUsed | string | нет | ||
| serviceName | string | Название сервиса | нет | |
| serviceVersion | string | Версия сервиса | нет | |
| skills | string[] | Список скиллов, которыми обладает нода сервиса | нет | |
| dockerHost | string | Идентификатор docker хоста, если нода запущена в контейнере | нет | |
| containerId | string | Идентификатор docker контейнера, если нода запущена в контейнере | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.ExternalRegistrationEx
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| metricPath | string | нет | ||
| metricPortScheme | PortScheme | |||
| metricPort | integer (int32) | нет | ||
| languageUsed | string | нет | ||
| scheme | string | Схема протокола | нет | |
| serviceName | string | Название сервиса | нет | |
| serviceVersion | string | Версия сервиса | нет | |
| skills | string[] | Список скиллов, которыми обладает нода сервиса | нет | |
| dockerHost | string | Идентификатор docker хоста, если нода запущена в контейнере | нет | |
| containerId | string | Идентификатор docker контейнера, если нода запущена в контейнере | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.Info
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя cервиса | нет | |
| ip | string | IP адрес | нет | |
| status | Status | |||
| lastPing | string (date-time) | Время последнего пинга ноды | нет | |
| skills | string[] | Список скилов которые реализует данная нода сервиса | нет | |
| id | string | Node ID | нет | |
| version | string | нет | ||
| configVersion | string | нет | ||
| apiVersion | string | нет | ||
| dbVersion | string | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.InfoResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Info | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.PortAllocationTypes
Базовый тип перечисления: string Возможные значения: Custom, Config, Random
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.PortScheme
Базовый тип перечисления: integer (int32) Возможные значения: 0, 1
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.ProtocolTypes
Базовый тип перечисления: string Возможные значения: IPv4, IPv6
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.RegistrationEx
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| metricPath | string | нет | ||
| metricPortScheme | PortScheme | |||
| metricPort | integer (int32) | нет | ||
| languageUsed | string | нет | ||
| serviceName | string | Название сервиса | нет | |
| serviceVersion | string | нет | ||
| configVersion | string | Версия используемой конфигурации | нет | |
| apiVersion | string | Версия API | нет | |
| dbVersion | string | Версия БД | нет | |
| workPort | integer (int32) | Порт, который должен быть присвоен ноде. Если порт равен 0, то присваевается 443 порт | нет | |
| portAllocation | PortAllocationTypes | |||
| skills | string[] | Список "скилов" | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.RegistrationResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.Results.ExternalRegistrationApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ExternalRegistrationResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.Results.ExternalRegistrationResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nodeId | string | Идентификатор под которым зарегистрирована нода | нет | |
| port | integer (int32) | Порт, на котором работает нода | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Results.SkillServiceInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет | |
| displayName | string | Полное описание сервиса | нет | |
| versions | string[] | Список версии нод | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Results.SkillServicesApiResult
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | SkillServiceInfo[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.ServiceVersionIdentifier
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет | |
| serviceVersion | string | Версия сервиса | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Status
Базовый тип перечисления: string Возможные значения: Work, NotWork, NotApprove, Block
ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Type
Базовый тип перечисления: string Возможные значения: None, Product, Configuration, Platform, DevTools
ASE.MD.Platform.Infrastructure.Discovery.Models.ServiceChangeParameter
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя сервиса | нет | |
| description | string | Полное описание сервиса | нет | |
| title | string | Краткое описание сервиса | нет | |
| type | Type | |||
| syncToNginx | boolean | Признак необходимости синхронизациис nginx | нет | |
| useNginxWorkStatus | boolean | нет | ||
| isSystem | boolean | Признак системного сервиса | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.ServiceIdentifier
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | Имя сервиса | нет |
ASE.MD.Platform.Infrastructure.Discovery.Models.Skills.SkillParameter
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| skillName | string | Название скила | нет |
ASE.MD.Platform.Utils.ModelsBase.ApiResults.TypeInfo
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя типа. | нет |