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

Текущая версия от 12:29, 29 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / Сетевые зоны / GET всех сетевых зон

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

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

GET	АппОптима использует кластерный 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"
    }
  ]
}

@@ Строка 1: / Строка 1: @@
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=GET%20%2D%20%D0%BA%D0%BE%D0%BD%D0%B2%D0%B5%D1%80%D1%82%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D1%82%D1%8C%20%D0%B5%D0%B4%D0%B8%D0%BD%D0%B8%D1%86%D1%8B-,%D0%A1%D0%B5%D1%82%D0%B5%D0%B2%D1%8B%D0%B5%20%D0%B7%D0%BE%D0%BD%D1%8B,-GET%20%D0%B2%D1%81%D0%B5%D1%85%20%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D1%8B%D1%85 Сетевые зоны] / GET всех сетевых зон'''''
 Список всех существующих сетевых зон.
@@ Строка 96: / Строка 98: @@
       }
     ]
-  }</code>
+  }