Node
/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
/api/Node/RegistrationV1
Зарегистрировать ноду сервиса
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Данные для регистрации
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| serviceName | string | нет | ||
| serviceVersion | string | нет | ||
| configVersion | string | нет | ||
| apiVersion | string | нет | ||
| dbVersion | string | нет | ||
| workPort | integer (int32) | нет | ||
| portAllocation | PortAllocationTypes | |||
| skills | string[] | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | Данные результата метода API. | да | |
| error | Info | да | ||
| typeInfo | TypeInfo |
/api/Node/CmdPing
Пинг от ноды
Это версия используется в новой версии клиента/сервера для обеспечения поддержки функционала работы с сервисом PKI
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| nodeId | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | Command | да | ||
| 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 |