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

Материал из Dynatrace
Версия от 15:21, 17 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: « Запрос потребляет <code>application/json</code>полезную нагрузку. {| class="wikitable" | rowspan="3" |ПОЧТА |Удалось...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)


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

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

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

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

Параметры

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

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

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

Объект _ RemoteConfigurationManagementOperationActiveGateRequest

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

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

Объект _ RemoteConfigurationManagementOperation

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

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

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

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

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

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

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

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

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

Ответ

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

Коды ответов

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

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

Объект _ RemoteConfigurationManagementJob

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

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

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

  • ACTIVE_GATE
  • ONE_AGENT
я бы нить Идентификатор задания удаленного управления конфигурацией.
время начала нить Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') запуска задания удаленного управления конфигурацией.
время окончания нить Дата (в формате ISO 8601: гггг-ММ-дд'Т'ЧЧ:мм:сс.ССС'Z') завершения задания удаленного управления конфигурацией. Это поле присутствует только для готовых работ.

Объект _ RemoteConfigurationManagementOperation

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

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

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

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

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

  • clear
  • set

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"
}

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

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

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

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

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

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

Ответ

Коды ответов

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