POST предпросмотр работы*

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

Вы можете создать предварительный просмотр перед выполнением фактического изменения конфигурации.

Предварительный просмотр говорит вам:

  • Сколько объектов в настоящее время настроено, как описано в полезной нагрузке
  • Сколько объектов будет настроено таким образом при отправке запроса на реконфигурацию

Запрос использует в качестве полезной нагрузки application/json формат.

POST Managed https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write ActiveGates ( activeGates.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимый
body RemoteConfigurationManagementOperationActiveGateRequest Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией. body требуется

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

Объект RemoteConfigurationManagementOperationActiveGateRequest

Запрос на создание операции удаленного управления конфигурацией.

Элемент Тип Описание Необходимость
operations RemoteConfigurationManagementOperation[] Список операций удаленного управления конфигурацией, которые необходимо выполнить. требуется
entities string[] Список идентификаторов объектов, для которых должно выполняться удаленное управление конфигурацией. требуется

Объект RemoteConfigurationManagementOperation

Определение одной операции удаленного управления конфигурацией.

Элемент Тип Описание Необходимость
attribute string Атрибут, на который влияет операция.

Элемент может содержать эти значения

  • group
  • hostGroup
  • networkZone
требуется
value string Значение, которое должно быть присвоено данному атрибуту. по желанию
operation string Операция, выполняемая над данным атрибутом.

Элемент может содержать эти значения

  • clear
  • set
требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

{
  "operations": [
    {
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ],
  "entities": [
    "0x2b7c0b02",
    "0x4928065d"
  ]
}

Ответ

Коды ответов

Код Тип Описание
200 RemoteConfigurationManagementPreviewList Успех
400 RemoteConfigurationManagementValidationResult Не удалось. Ввод недействителен.

Объекты тела ответа

Объект _ RemoteConfigurationManagementPreviewList

Список предварительных просмотров заданий удаленного управления конфигурацией.

Элемент Тип Описание
previews RemoteConfigurationManagementJobPreview[] Список предварительных просмотров заданий удаленного управления конфигурацией.

Объект RemoteConfigurationManagementJobPreview

Предварительный просмотр задания удаленного управления конфигурацией.

Элемент Элемент Описание
alreadyConfiguredEntitiesCount integer Количество объектов, которые в настоящее время настроены в соответствии с операцией удаленного управления конфигурацией.
targetEntitiesCount integer Количество объектов, которые будут настроены в соответствии с определением удаленного управления конфигурацией после его завершения.
attribute string Атрибут, на который влияет операция.

Элемент может содержать эти значения

  • group
  • hostGroup
  • networkZone
value string Значение, которое должно быть присвоено данному атрибуту.
operation string Операция, выполняемая над данным атрибутом.

Элемент может содержать эти значения

  • clear
  • set

JSON-модель тела ответа

{
  "previews": [
    {
      "alreadyConfiguredEntitiesCount": 1,
      "targetEntitiesCount": 2,
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ]
}