POST задание конфигурации

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

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

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

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

Параметры

Вы идентифицируете своих агентов OneAgent по их идентификаторам. Используйте OneAgent в запросе хоста, чтобы узнать идентификаторы OneAgent, которые вы хотите настроить.

Параметр	Тип	Описание	В	Необходимый
запустить снова	логический	Если установлено значение false, OneAgents не будет перезапущен после применения конфигурации.	запрос	по желанию
тело	Операция удаленного управления конфигурацией Один запрос агента	Тело запроса в формате JSON, содержащее определение задания удаленного управления конфигурацией.	тело	требуется

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

Объект _ RemoteConfigurationManagementOperationOneAgentRequest

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

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

Объект _ RemoteConfigurationManagementOperation

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

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

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

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

{
  "operations": [
    {
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ],
  "entities": [
    "HOST-D454A967666E7970",
    "HOST-811760CFF2A5E872"
  ]
}

Ответ

Коды ответов

Код	Тип	Описание
201	Задание удаленного управления конфигурацией	Созданный
400	RemoteConfigurationManagementValidationResult	Не удалось. Ввод недействителен.
409		В настоящее время выполняется другое задание удаленного управления конфигурацией.

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

Объект _ RemoteConfigurationManagementJob

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

Элемент	Тип	Описание
тайм-аутВремя	нить	Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.SSS'Z'), когда истечет время ожидания запущенного задания удаленного управления конфигурацией. Это поле присутствует только для запущенных заданий.
обработаноEntitiesCount	целое число	Количество объектов, которые уже были обработаны на момент создания ответа.
TotalEntitiesCount	целое число	Общее количество объектов для обработки.
операции	Операция удаленного управления конфигурацией []	Список выполненных заданий удаленного управления конфигурацией.
тип объекта	нить	Тип объектов, измененных удаленным управлением конфигурацией. Элемент может содержать эти значения
я бы	нить	Идентификатор задания удаленного управления конфигурацией.
время начала	нить	Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') запуска задания удаленного управления конфигурацией.
время окончания	нить	Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') завершения задания удаленного управления конфигурацией. Это поле присутствует только для готовых работ.

Объект _ RemoteConfigurationManagementOperation

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

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

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

{
  "timeoutTime": "2020-11-05T08:15:30.144Z",
  "processedEntitiesCount": 1,
  "totalEntitiesCount": 1,
  "operations": [
    {
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ],
  "entityType": "ACTIVE_GATE or ONE_AGENT",
  "id": "7974003406714390819",
  "startTime": "2020-11-05T08:15:30.144Z",
  "endTime": "2020-11-05T08:15:30.144Z"
}

Ответ не отправляется клиенту до тех пор, пока не будут обработаны все агенты OneAgent, определенные в полезной нагрузке. OneAgent считается обработанным, когда ему отправляется сообщение о реконфигурации; фактическая реконфигурация выполняется независимо OneAgent.

Проверить полезную нагрузку

Мы рекомендуем вам проверить полезную нагрузку перед ее отправкой с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

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

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

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

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

Ответ

Коды ответов

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