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

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

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

Получает информацию об указанной сетевой зоне.

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

GET	АппОптима Использование API кластера .

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

Чтобы выполнить этот запрос, вам необходимо разрешение Чтение зон сети ( 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"
}

@@ Строка 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 одной сетевой зоны'''''
 Получает информацию об указанной сетевой зоне.
 Запрос создает <code>application/json</code>полезную нагрузку.
 {| class="wikitable"
-|ПОЛУЧИТЬ
+|GET
 |
-* Managed Использование API кластера .
+* АппОптима Использование API кластера .
 |}
@@ Строка 54: / Строка 56: @@
 |-
 |numOfOneAgentsUsing
-|целое число
+|integer
 |Количество ЕдиныхАгентов, использующих АктивныйШлюз в сетевой зоне.
 |-
 |numOfConfiguredOneAgents
-|целое число
+|integer
 |Количество ЕдиныхАгентов, которые настроены на использование сетевой зоны в качестве основного.
 |-
 |numOfOneAgentsFromOtherZones
-|целое число
+|integer
 |Количество ЕдиныхАгентов из других зон сети, которые используют АктивныеШлюзы в зоне сети.
@@ Строка 70: / Строка 72: @@
 |-
 |numOfConfiguredActiveGates
-|целое число
+|integer
 |Количество АктиныхШлюзов в сетевой зоне.
 |-
@@ Строка 83: / Строка 85: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "alternativeZones": [
       "string"
@@ Строка 93: / Строка 95: @@
     "id": "string",
     "description": "string"
-  }</code>
+  }