IKuznetsov в 18:26, 2 января 2025

2025-01-02T18:26:19Z

← Предыдущая версия		Версия от 18:26, 2 января 2025
Строка 76:		Строка 76:
	\|communicationEndpoints		\|communicationEndpoints
	\|string[]		\|string[]
	\|Список конечных точек для подключения к среде ~~Ключ-АСТРОМ~~. Список отсортирован по приоритету конечной точки, по убыванию.		\|Список конечных точек для подключения к среде АппОптима. Список отсортирован по приоритету конечной точки, по убыванию.
	\|-		\|-
	\|formattedCommunicationEndpoints		\|formattedCommunicationEndpoints
	\|string[]		\|string[]
	\|Отформатированный список конечных точек для подключения к среде ~~Ключ-АСТРОМ~~.		\|Отформатированный список конечных точек для подключения к среде АппОптима.
	\|-		\|-
	\|tenantToken		\|tenantToken
	\|string		\|string
	\|Внутренний токен, который используется для аутентификации, когда ЕдиныйАгент подключается к кластеру ~~Ключ-АСТРОМ~~ для отправки данных.		\|Внутренний токен, который используется для аутентификации, когда ЕдиныйАгент подключается к кластеру АппОптима для отправки данных.
	\|-		\|-
	\|tenantUUID		\|tenantUUID
	\|string		\|string
	\|Идентификатор вашей среды ~~Ключ-АСТРОМ~~.		\|Идентификатор вашей среды АппОптима.
	\|}		\|}

IKuznetsov: Новая страница: «Получает информацию о подключении для ЕдиногоАгента. Запрос `application/json` создает по...»

2024-10-18T17:26:32Z

Новая страница: «Получает информацию о подключении для ЕдиногоАгента. Запрос <code>application/json</code> создает по...»

Новая страница

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

Запрос <code>application/json</code> создает полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|SaaS
|<code><nowiki>https://{your-environment-id}.live.astromkey.com/api/v1/deployment/installer/agent/connectioninfo</nowiki></code>
|-
|Environment АктивныйШлюз
|<code><nowiki>https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/deployment/installer/agent/connectioninfo</nowiki></code>
|}

== Аутентификация ==
Для выполнения этого запроса вам понадобится токен доступа <code>InstallerDownload</code> с областью действия.

== Параметры ==
{| class="wikitable"
|+
!Параметр
!Тип
!Описание
!Находится в
!Необходимость
|-
|networkZone
|string
|Зона сети, для которой вы хотите настроить результат.
|запрос
|необязательный
|-
|defaultZoneFallback
|boolean
|Установите параметр <code>true</code> для выполнения отката к сетевой зоне по умолчанию, если указанная сетевая зона не существует.
|запрос
|необязательный
|-
|version
|string
|Версия ЕдиногоАгента, для которой вы запрашиваете информацию о подключении, в <code>1.221</code> формате.

Установите этот параметр, чтобы получить наилучший формат списка конечных точек для оптимальной производительности.
|запрос
|необязательный
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|200
|Информация о подключении
|Успех
|-
|4ХХ
|Конверт ошибки
|Ошибка на стороне клиента.
|-
|5ХХ
|Конверт ошибки
|Ошибка на стороне сервера.
|}

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

==== Объект <code>ConnectionInfo</code> ====
Информация о подключении ЕдиногоАгента.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|communicationEndpoints
|string[]
|Список конечных точек для подключения к среде Ключ-АСТРОМ. Список отсортирован по приоритету конечной точки, по убыванию.
|-
|formattedCommunicationEndpoints
|string[]
|Отформатированный список конечных точек для подключения к среде Ключ-АСТРОМ.
|-
|tenantToken
|string
|Внутренний токен, который используется для аутентификации, когда ЕдиныйАгент подключается к кластеру Ключ-АСТРОМ для отправки данных.
|-
|tenantUUID
|string
|Идентификатор вашей среды Ключ-АСТРОМ.
|}

=== Модель тела ответа JSON ===
{| class="wikitable"
|<code>{</code>
<code> "communicationEndpoints": [</code>

<code> "string"</code>

<code> ],</code>

<code> "formattedCommunicationEndpoints": [</code>

<code> "string"</code>

<code> ],</code>

<code> "tenantToken": "string",</code>

<code> "tenantUUID": "string"</code>

<code>}</code>
|}

Просмотр информации о подключении - История изменений

IKuznetsov в 18:26, 2 января 2025

IKuznetsov: Новая страница: «Получает информацию о подключении для ЕдиногоАгента. Запрос application/json создает по...»

IKuznetsov: Новая страница: «Получает информацию о подключении для ЕдиногоАгента. Запрос `application/json` создает по...»