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

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

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

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

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

ПОЧТА	Удалось	https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview
	SaaS	https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/remoteConfigurationManagement/preview
	Окружающая среда ActiveGate	https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview

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

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

Параметры

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

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

Объект _ RemoteConfigurationManagementOperationActiveGateRequest

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

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

Объект _ RemoteConfigurationManagementOperation

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

Элемент	Тип	Описание	Необходимый
атрибут	нить	Атрибут, на который влияет операция. Элемент может содержать эти значения group hostGroup networkZone	требуется
ценность	нить	Значение, которое должно быть присвоено данному атрибуту.	по желанию
операция	нить	Операция, выполняемая над данным атрибутом. Элемент может содержать эти значения clear set	требуется

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

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

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

Ответ

Коды ответов

Код	Тип	Описание
200	Предварительный список удаленного управления конфигурацией	Успех
400	RemoteConfigurationManagementValidationResult	Не удалось. Ввод недействителен.

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

Объект _ RemoteConfigurationManagementPreviewList

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

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

Объект _ RemoteConfigurationManagementJobPreview

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

Элемент	Тип	Описание
уже сконфигурированный EntitiesCount	целое число	Количество объектов, которые в настоящее время настроены в соответствии с операцией удаленного управления конфигурацией.
targetEntitiesCount	целое число	Количество объектов, которые будут настроены в соответствии с определением удаленного управления конфигурацией после его завершения.
атрибут	нить	Атрибут, на который влияет операция. Элемент может содержать эти значения group hostGroup networkZone
ценность	нить	Значение, которое должно быть присвоено данному атрибуту.
операция	нить	Операция, выполняемая над данным атрибутом. Элемент может содержать эти значения clear set

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

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