Перейти к основному содержимому

Взаимодействие с внешними неподконтрольными системами.

/api/external/Registration

Регистрация узла внешнего внешнего сервиса.

Данный метод сервиса будет использоваться сторонними разработчиками для регистрации своих сервисов

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Название поляТип поляОписаниеОбязательноеВозможные значения
metricPathstringнет
metricPortSchemePortScheme
metricPortinteger (int32)нет
languageUsedstringнет
serviceNamestringНазвание сервисанет
serviceVersionstringВерсия сервисанет
skillsstring[]Список скиллов, которыми обладает нода сервисанет
dockerHoststringИдентификатор docker хоста, если нода запущена в контейнеренет
containerIdstringИдентификатор docker контейнера, если нода запущена в контейнеренет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поляТип поляОписаниеОбязательноеВозможные значения
resultExternalRegistrationResultда
errorInfoда
typeInfoTypeInfo

Код 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

Название поляТип поляОписаниеОбязательноеВозможные значения
metricPathstringнет
metricPortSchemePortScheme
metricPortinteger (int32)нет
languageUsedstringнет
schemestringСхема протоколанет
serviceNamestringНазвание сервисанет
serviceVersionstringВерсия сервисанет
skillsstring[]Список скиллов, которыми обладает нода сервисанет
dockerHoststringИдентификатор docker хоста, если нода запущена в контейнеренет
containerIdstringИдентификатор docker контейнера, если нода запущена в контейнеренет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поляТип поляОписаниеОбязательноеВозможные значения
resultExternalRegistrationResultда
errorInfoда
typeInfoTypeInfo

Код 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

Название поляТип поляОписаниеОбязательноеВозможные значения
nodeIdstringИдентификатор ноды, которая послала пингнет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поляТип поляОписаниеОбязательноеВозможные значения
resultCommandда
errorInfoда
typeInfoTypeInfo

Код 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