GET всех сетевых зон

Материал из Документация Ключ-АСТРОМ
Версия от 07:36, 11 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Список всех существующих сетевых зон. Запрос выдает <code>application/json</code>полезную нагрузку. {...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Список всех существующих сетевых зон.

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

GET
  • Managed использует кластерный API.

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

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

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код Тип Описание
200 Список сетевых зон Успех

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

Объект NetworkZoneList

Список сетевых зон.

Элемент Тип Описание
Сетевые зоны Сетеваязона[] Список сетевых зон.

Объект NetworkZone

Настройка сетевой зоны.

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

Это часть использования numOfOneAgentsUsing.

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

numOfConfiguredActiveGates целое число Количество активных гейтов в сетевой зоне.
ID строка Идентификатор сетевой зоны
Описание строка Краткое описание сетевой зоны

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

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