PUT сетевой зоны

Материал из Документация Ключ-АСТРОМ
Версия от 08:10, 11 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Обновляет указанную сетевую зону. Если сетевая зона с указанным идентификатором не суще...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Обновляет указанную сетевую зону. Если сетевая зона с указанным идентификатором не существует, создается новая сетевая зона.

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

PUT
  • Managed Использование API кластера .

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

Чтобы выполнить этот запрос, вам необходимо разрешение Чтение зон сети ( networkZones.read), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см . Аутентификация .

Параметры

Параметр Тип Описание In Необходимость
id string Идентификатор сетевой зоны, которую необходимо обновить.

Если вы также устанавливаете идентификатор в теле сообщения, он должен совпадать с этим идентификатором.

Идентификатор не чувствителен к регистру. Ключ-АСТРОМ хранит идентификатор в нижнем регистре.

path требуется
body NetworkZone Тело JSON запроса. Содержит параметры сетевой зоны. body требуется

Объекты тела запроса

Объект 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"
}