Взаимодействие с внешними неподконтрольными системами.
/api/external/Registration
Регистрация узла внешнего внешнего сервиса.
Данный метод сервиса будет использоваться сторонними разработчиками для регистрации своих сервисов
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
metricPath | string | нет | ||
metricPortScheme | PortScheme | |||
metricPort | integer (int32) | нет | ||
languageUsed | string | нет | ||
serviceName | string | Название сервиса | нет | |
serviceVersion | string | Версия сервиса | нет | |
skills | string[] | Список скиллов, которыми обладает нода сервиса | нет | |
dockerHost | string | Идентификатор docker хоста, если нода запущена в контейнере | нет | |
containerId | string | Идентификатор docker контейнера, если нода запущена в контейнере | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
result | ExternalRegistrationResult | да | ||
error | Info | да | ||
typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/Discovery public ExternalController ExternalNodeInstall(ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.ExternalRegistration)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
Название | Значение |
---|---|
Тип | authorizationCode |
Авторизация | /identity/connect/authorize |
Выдача токена | /identity/connect/token |
Обновление | |
Области разрешений доступа | discovery:external: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/external/RegistrationV1
Регистрация ноды внешнего сервиса (альтернативная).
Данный метод сервиса будет использоваться сторонними разработчиками для регистрации своих сервисов
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
metricPath | string | нет | ||
metricPortScheme | PortScheme | |||
metricPort | integer (int32) | нет | ||
languageUsed | string | нет | ||
scheme | string | Схема протокола | нет | |
serviceName | string | Название сервиса | нет | |
serviceVersion | string | Версия сервиса | нет | |
skills | string[] | Список скиллов, которыми обладает нода сервиса | нет | |
dockerHost | string | Идентификатор docker хоста, если нода запущена в контейнере | нет | |
containerId | string | Идентификатор docker контейнера, если нода запущена в контейнере | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
result | ExternalRegistrationResult | да | ||
error | Info | да | ||
typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/Discovery public ExternalController ExternalNodeRegistrationEx(ASE.MD.Platform.Infrastructure.Discovery.Models.Service.Node.ExternalRegistrationEx)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
Название | Значение |
---|---|
Тип | authorizationCode |
Авторизация | /identity/connect/authorize |
Выдача токена | /identity/connect/token |
Обновление | |
Области разрешений доступа | discovery:external: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/external/Ping
Пинг от узла внешнего сервиса.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
nodeId | string | Идентификатор ноды, которая послала пинг | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
Название поля | Тип поля | Описание | Обязательное | Возможные значения |
---|---|---|---|---|
result | Command | да | ||
error | Info | да | ||
typeInfo | TypeInfo |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/Discovery public ExternalController ExternalNodePing(ASE.MD.Platform.Infrastructure.Discovery.Models.Ping.ExternalPingInfo)
Тип схемы безопасности: oauth2
Р асположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
Название | Значение |
---|---|
Тип | authorizationCode |
Авторизация | /identity/connect/authorize |
Выдача токена | /identity/connect/token |
Обновление | |
Области разрешений доступа |
/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 |