GET задание по настройке*

Материал из Документация Ключ-АСТРОМ
Версия от 15:30, 17 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Получает параметры задания конфигурации для ActiveGates. Запрос создает <code>application/json</code>поле...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Получает параметры задания конфигурации для ActiveGates.

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

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

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

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

Параметры

Параметр Тип Описание В Необходимый
я бы нить Идентификатор требуемого задания удаленного управления конфигурацией. дорожка требуется

Ответ

Коды ответов

Код Тип Описание
200 Задание удаленного управления конфигурацией Успех
404 ErrorEnvelope Не удалось. Запрошенный ресурс не существует.

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

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