GET всех сетевых зон: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Список всех существующих сетевых зон. Запрос выдает <code>application/json</code>полезную нагрузку. {...»)
 
 
Строка 23: Строка 23:
|-
|-
|200
|200
|Список сетевых зон
|NetworkZoneList
|Успех
|Успех
|}
|}
Строка 36: Строка 36:
!Описание
!Описание
|-
|-
|Сетевые зоны
|networkZones
|Сетеваязона[]
|NetworkZone[]
|Список сетевых зон.
|Список сетевых зон.
|}
|}
Строка 48: Строка 48:
!Описание
!Описание
|-
|-
|Альтернативные зоны
|alternativeZones
|строка[]
|string[]
|Список альтернативных сетевых зон.
|Список альтернативных сетевых зон.
|-
|-
|numOfOneAgentsUsing
|numOfOneAgentsUsing
|целое число
|integer
|Количество OneAgents, которые используют ActiveGates в сетевой зоне.
|Количество ЕдиныхАгентов, которые используют АктивныеШлюзы в сетевой зоне.
|-
|-
|numOfConfiguredOneAgents
|numOfConfiguredOneAgents
|целое число
|integer
|Количество OneAgents, настроенных на использование сетевой зоны в качестве основной.
|Количество ЕдиныхАгентов, настроенных на использование сетевой зоны в качестве основной.
|-
|-
|numOfOneAgentsFromOtherZones
|numOfOneAgentsFromOtherZones
|целое число
|integer
|Количество OneAgents из других сетевых зон, которые используют ActiveGates в сетевой зоне.
|Количество ЕдиныхАгентов из других сетевых зон, которые используют АктивныеШлюзы в сетевой зоне.


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


Одной из возможных причин переключения в другую зону является то, что брандмауэр не позволяет OneAgent подключиться к любому ActiveGate в предпочтительной сетевой зоне.
Одной из возможных причин переключения в другую зону является то, что брандмауэр не позволяет ЕдиномуАгенту подключиться к любому АктивномуШлюзу в предпочтительной сетевой зоне.
|-
|-
|numOfConfiguredActiveGates
|numOfConfiguredActiveGates
|целое число
|integer
|Количество активных гейтов в сетевой зоне.
|Количество активных гейтов в сетевой зоне.
|-
|-
|ID
|id
|строка
|string
|Идентификатор сетевой зоны
|Идентификатор сетевой зоны
|-
|-
|Описание
|description
|строка
|string
|Краткое описание сетевой зоны
|Краткое описание сетевой зоны
|}
|}

Текущая версия на 07:46, 11 октября 2022

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

Запрос выдает 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"
    }
  ]
}