GET одной сетевой зоны

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

Получает информацию об указанной сетевой зоне.

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

GET
  • Managed Использование API кластера .

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

Чтобы выполнить этот запрос, вам необходимо разрешение Чтение зон сети ( networkZones.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см . Аутентификация .

Параметры

Параметр Тип Описание In Необходимость
id string Идентификатор требуемой сетевой зоны. path требуется

Ответ

Коды ответов

Код Тип Описание
200 NetworkZone Успех

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

Объект NetworkZone

Конфигурация сетевой зоны.

Элемент Тип Описание
alternativeZones string [] Список альтернативных зон сети.
numOfOneAgentsUsing целое число Количество ЕдиныхАгентов, использующих АктивныйШлюз в сетевой зоне.
numOfConfiguredOneAgents целое число Количество ЕдиныхАгентов, которые настроены на использование сетевой зоны в качестве основного.
numOfOneAgentsFromOtherZones целое число Количество ЕдиныхАгентов из других зон сети, которые используют АктивныеШлюзы в зоне сети.

Это часть  numOfOneAgentsUsing .

Одной из возможных причин переключения на другую зону является то, что брандмауэр не позволяет ЕдиномуАгенту подключиться к любому АктивномуШлюзу в предпочтительной сетевой зоне.

numOfConfiguredActiveGates целое число Количество АктиныхШлюзов в сетевой зоне.
id string Идентификатор сетевой зоны
description string Краткое описание сетевой зоны

JSON-модель тела ответа

{
  "alternativeZones": [
    "string"
  ],
  "numOfOneAgentsUsing": 1,
  "numOfConfiguredOneAgents": 1,
  "numOfOneAgentsFromOtherZones": 1,
  "numOfConfiguredActiveGates": 1,
  "id": "string",
  "description": "string"
}