GET одной сетевой зоны: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «Получает информацию об указанной сетевой зоне. Запрос создает <code>application/json</code>полезную...») |
ENetrebin (обсуждение | вклад) |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 3: | Строка 3: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| | |GET | ||
| | | | ||
| Строка 54: | Строка 54: | ||
|- | |- | ||
|numOfOneAgentsUsing | |numOfOneAgentsUsing | ||
| | |integer | ||
|Количество ЕдиныхАгентов, использующих АктивныйШлюз в сетевой зоне. | |Количество ЕдиныхАгентов, использующих АктивныйШлюз в сетевой зоне. | ||
|- | |- | ||
|numOfConfiguredOneAgents | |numOfConfiguredOneAgents | ||
| | |integer | ||
|Количество ЕдиныхАгентов, которые настроены на использование сетевой зоны в качестве основного. | |Количество ЕдиныхАгентов, которые настроены на использование сетевой зоны в качестве основного. | ||
|- | |- | ||
|numOfOneAgentsFromOtherZones | |numOfOneAgentsFromOtherZones | ||
| | |integer | ||
|Количество ЕдиныхАгентов из других зон сети, которые используют АктивныеШлюзы в зоне сети. | |Количество ЕдиныхАгентов из других зон сети, которые используют АктивныеШлюзы в зоне сети. | ||
| Строка 70: | Строка 70: | ||
|- | |- | ||
|numOfConfiguredActiveGates | |numOfConfiguredActiveGates | ||
| | |integer | ||
|Количество АктиныхШлюзов в сетевой зоне. | |Количество АктиныхШлюзов в сетевой зоне. | ||
|- | |- | ||
Текущая версия на 07:58, 11 октября 2022
Получает информацию об указанной сетевой зоне.
Запрос создает application/jsonполезную нагрузку.
| GET |
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение Чтение зон сети ( networkZones.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см . Аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| id | string | Идентификатор требуемой сетевой зоны. | path | требуется |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | NetworkZone | Успех |
Объекты тела ответа
Объект NetworkZone
Конфигурация сетевой зоны.
| Элемент | Тип | Описание |
|---|---|---|
| alternativeZones | string [] | Список альтернативных зон сети. |
| numOfOneAgentsUsing | integer | Количество ЕдиныхАгентов, использующих АктивныйШлюз в сетевой зоне. |
| numOfConfiguredOneAgents | integer | Количество ЕдиныхАгентов, которые настроены на использование сетевой зоны в качестве основного. |
| numOfOneAgentsFromOtherZones | integer | Количество ЕдиныхАгентов из других зон сети, которые используют АктивныеШлюзы в зоне сети.
Это часть numOfOneAgentsUsing . Одной из возможных причин переключения на другую зону является то, что брандмауэр не позволяет ЕдиномуАгенту подключиться к любому АктивномуШлюзу в предпочтительной сетевой зоне. |
| numOfConfiguredActiveGates | integer | Количество АктиныхШлюзов в сетевой зоне. |
| id | string | Идентификатор сетевой зоны |
| description | string | Краткое описание сетевой зоны |
JSON-модель тела ответа
{
"alternativeZones": [
"string"
],
"numOfOneAgentsUsing": 1,
"numOfConfiguredOneAgents": 1,
"numOfOneAgentsFromOtherZones": 1,
"numOfConfiguredActiveGates": 1,
"id": "string",
"description": "string"
}
