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

Материал из Документация Ключ-АСТРОМ
Версия от 07:46, 11 октября 2022; ENetrebin (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

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

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

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

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

Параметры

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

Ответ

Коды ответов

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

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

Объект NetworkZoneList

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

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

Объект NetworkZone

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

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

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

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

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

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

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