Регистрация и взаимодействие с узлами сервисов.
/api/Node/delete
Удалить узел сервиса.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Идентификатор ноды
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nodeUid | 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 NodeController NodeDeletePost(ASE.MD.Platform.Infrastructure.Discovery.Models.NodeIdentifier)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | discovery:node: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/Node/RegistrationV1
Зарегистрировать узел сервиса.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные для регистрации.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| 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[] | Список "скилов" | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/api/Node/ping
Принять пинг от узла сервиса.
Возвращается информация о необходимости выполнения нодой каких-либо действий.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nodeUid | string | Идентификатор ноды | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | PingInfoResult | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |
/api/Node/config
Получение конфигурации узла сервиса.
Возвращает модель, содержащую список элементов конфигурации узла в формате ключ-значение-источник.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Модель с идентификатором узла сервиса.
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nodeUid | string | Идентификатор ноды | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ConfigSettingDetail[] | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/api/Node/CmdPing
[Устарел] Принять пинг от узла сервиса (для поддержки работы с сервисом PKI).
Это версия используется в новой версии клиента/сервера для обеспечения поддержки функционала работы с сервисом PKI
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nodeId | string | Идентификатор ноды, которая послала пинг | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Command | да | ||
| error | Info | да | ||
| typeInfo | TypeInfo |