API развертывания — просмотр информации о подключении к ЕдиномуАгенту

Материал из Документация Ключ-АСТРОМ

API развертывания — просмотр информации о подключении к ЕдиномуАгенту

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

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

SaaS: https://{your-environment-id}.live.astromkey.com/api/v1/deployment/installer/agent/connectioninfo

Среда Активного Шлюза: https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/deployment/installer/agent/connectioninfo

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

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

Чтобы узнать, как получить и использовать его, см. раздел «Токены и аутентификация».

Параметры

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

Ответ

Коды ответов

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

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

Объект ConnectionInfo

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

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

Объект ErrorEnvelope

Элемент Тип Описание
error Error -

Объект Error

Элемент Тип Описание
code integer Код состояния HTTP
constraintViolations ConstraintViolation [] Список нарушений ограничений
message string Сообщение об ошибке

Объект ConstraintViolation

Список нарушений ограничений

Элемент Тип Описание
location string -
message string -
parameterLocation string -

Этот элемент может содержать следующие значения: HEADER, PATH, PAYLOAD_BODY, QUERY

path string -

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

Успешный ответ

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

Ответ с ошибкой

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}
Источник — https://doc.ruscomtech.ru/index.php?title=API_развертывания_—_просмотр_информации_о_подключении_к_ЕдиномуАгенту&oldid=6502