Просмотр информации о подключении

Получает информацию о подключении для ЕдиногоАгента.

Запрос application/json создает полезную нагрузку.

GET	SaaS	https://{your-environment-id}.live.astromkey.com/api/v1/deployment/installer/agent/connectioninfo
	Environment АктивныйШлюз	https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/deployment/installer/agent/connectioninfo

Аутентификация

Для выполнения этого запроса вам понадобится токен доступа InstallerDownload с областью действия.

Параметры

Параметр	Тип	Описание	Находится в	Необходимость
networkZone	string	Зона сети, для которой вы хотите настроить результат.	запрос	необязательный
defaultZoneFallback	boolean	Установите параметр true для выполнения отката к сетевой зоне по умолчанию, если указанная сетевая зона не существует.	запрос	необязательный
version	string	Версия ЕдиногоАгента, для которой вы запрашиваете информацию о подключении, в 1.221 формате. Установите этот параметр, чтобы получить наилучший формат списка конечных точек для оптимальной производительности.	запрос	необязательный

Ответ

Коды ответов

Код	Тип	Описание
200	Информация о подключении	Успех
4ХХ	Конверт ошибки	Ошибка на стороне клиента.
5ХХ	Конверт ошибки	Ошибка на стороне сервера.

Объекты тела ответа

Объект ConnectionInfo​

Информация о подключении ЕдиногоАгента.

Элемент	Тип	Описание
communicationEndpoints	string[]	Список конечных точек для подключения к среде Ключ-АСТРОМ. Список отсортирован по приоритету конечной точки, по убыванию.
formattedCommunicationEndpoints	string[]	Отформатированный список конечных точек для подключения к среде Ключ-АСТРОМ.
tenantToken	string	Внутренний токен, который используется для аутентификации, когда ЕдиныйАгент подключается к кластеру Ключ-АСТРОМ для отправки данных.
tenantUUID	string	Идентификатор вашей среды Ключ-АСТРОМ.

Модель тела ответа JSON

{   "communicationEndpoints": [     "string"   ],   "formattedCommunicationEndpoints": [     "string"   ],   "tenantToken": "string",   "tenantUUID": "string" }