GET всех сетевых зон: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «Список всех существующих сетевых зон. Запрос выдает <code>application/json</code>полезную нагрузку. {...») |
ENetrebin (обсуждение | вклад) |
||
Строка 23: | Строка 23: | ||
|- | |- | ||
|200 | |200 | ||
| | |NetworkZoneList | ||
|Успех | |Успех | ||
|} | |} | ||
Строка 36: | Строка 36: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |networkZones | ||
| | |NetworkZone[] | ||
|Список сетевых зон. | |Список сетевых зон. | ||
|} | |} | ||
Строка 48: | Строка 48: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |alternativeZones | ||
| | |string[] | ||
|Список альтернативных сетевых зон. | |Список альтернативных сетевых зон. | ||
|- | |- | ||
|numOfOneAgentsUsing | |numOfOneAgentsUsing | ||
| | |integer | ||
|Количество | |Количество ЕдиныхАгентов, которые используют АктивныеШлюзы в сетевой зоне. | ||
|- | |- | ||
|numOfConfiguredOneAgents | |numOfConfiguredOneAgents | ||
| | |integer | ||
|Количество | |Количество ЕдиныхАгентов, настроенных на использование сетевой зоны в качестве основной. | ||
|- | |- | ||
|numOfOneAgentsFromOtherZones | |numOfOneAgentsFromOtherZones | ||
| | |integer | ||
|Количество | |Количество ЕдиныхАгентов из других сетевых зон, которые используют АктивныеШлюзы в сетевой зоне. | ||
Это часть использования numOfOneAgentsUsing. | Это часть использования numOfOneAgentsUsing. | ||
Одной из возможных причин переключения в другую зону является то, что брандмауэр не позволяет | Одной из возможных причин переключения в другую зону является то, что брандмауэр не позволяет ЕдиномуАгенту подключиться к любому АктивномуШлюзу в предпочтительной сетевой зоне. | ||
|- | |- | ||
|numOfConfiguredActiveGates | |numOfConfiguredActiveGates | ||
| | |integer | ||
|Количество активных гейтов в сетевой зоне. | |Количество активных гейтов в сетевой зоне. | ||
|- | |- | ||
| | |id | ||
| | |string | ||
|Идентификатор сетевой зоны | |Идентификатор сетевой зоны | ||
|- | |- | ||
| | |description | ||
| | |string | ||
|Краткое описание сетевой зоны | |Краткое описание сетевой зоны | ||
|} | |} |
Текущая версия на 07:46, 11 октября 2022
Список всех существующих сетевых зон.
Запрос выдает application/json
полезную нагрузку.
GET |
|
Аутентификация
Для выполнения этого запроса вам необходимо разрешение 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"
}
]
}