Получение АктивныхШлюзов с автообновлением заданий

Список всех ActiveGate, у которых есть задания автоматического обновления. В список входят выполненные задания (успешные или неуспешные) и выполняемые задания.

Вы можете сузить вывод, указав параметры фильтрации в своем запросе.

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

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

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

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

Параметры

Параметр	Тип	Описание	В	Необходимый
от	нить	Начало запрошенного периода времени для заданий обновления. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма: m: минут h: часы d: дней w: недели M: месяцы y: годы Если не задано, используется относительный таймфрейм в один день ( now-1d). Максимальный срок 31 день.	запрос	необязательный
к	нить	Конец запрошенного периода времени для заданий обновления. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма: m: минут h: часы d: дней w: недели M: месяцы y: годы Если не установлено, используется текущая метка времени.	запрос	необязательный
startVersionCompareType	нить	Фильтрует результирующий набор заданий обновления по указанной исходной версии. Укажите здесь оператор сравнения. Элемент может содержать эти значения EQUAL GREATER GREATER_EQUAL LOWER LOWER_EQUAL	запрос	необязательный
стартовая версия	нить	Фильтрует результирующий набор update-jobs по начальной версии (обязательный формат <major>.<minor>.<revision>).	запрос	необязательный
тип обновления	нить	Фильтрует результирующий набор заданий обновления по типу обновления. Элемент может содержать эти значения ACTIVE_GATE REMOTE_PLUGIN_AGENT SYNTHETIC Z_REMOTE	запрос	необязательный
targetVersionCompareType	нить	Фильтрует результирующий набор заданий обновления по указанной целевой версии. Укажите здесь оператор сравнения. Элемент может содержать эти значения EQUAL GREATER GREATER_EQUAL LOWER LOWER_EQUAL	запрос	необязательный
целевая версия	нить	Фильтрует результирующий набор заданий обновления по целевой версии (обязательный формат <major>.<minor>.<revision>).	запрос	необязательный
последние обновления	логический	Если true, результирующий набор заданий обновления отфильтровывается до самого последнего обновления каждого типа.	запрос	необязательный

Ответ

Коды ответов

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

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

Объект _ UpdateJobsAll

Список ActiveGate с заданиями на обновление.

Элемент	Тип	Описание
всеобновитьработы	Обновить список заданий []	Список ActiveGate с заданиями на обновление. Может быть null.

Объект _ UpdateJobList

Список заданий обновления ActiveGate.

Элемент	Тип	Описание
agId	нить	Идентификатор ActiveGate. Может быть null.
обновлениеJobs	Обновить задание []	Список заданий обновления ActiveGate. Может быть null.

Объект _ UpdateJob

Настройка задания обновления ActiveGate.

Элемент	Тип	Описание
jobState	нить	Статус задания обновления. Элемент может содержать эти значения FAILED IN_PROGRESS PENDING ROLLBACK SCHEDULED SKIPPED SUCCEED Может быть null.
метод обновления	нить	Способ обновления ActiveGate или его компонентов. Элемент может содержать эти значения AUTOMATIC MANUAL_INSTALLATION ON_DEMAND Может быть null.
тип обновления	нить	Компонент, который нужно обновить. Элемент может содержать эти значения ACTIVE_GATE REMOTE_PLUGIN_AGENT SYNTHETIC Z_REMOTE Может быть null.
agType	нить	Тип ActiveGate. Элемент может содержать эти значения CLUSTER ENVIRONMENT ENVIRONMENT_MULTI Может быть null.
стартовая версия	нить	Начальная версия ActiveGate. Может быть null.
среды	строка []	Список сред (определяемых идентификаторами), к которым может подключаться ActiveGate. Может быть null.
отменяемый	логический	Задание может ( true) или не может ( false) быть отменено в данный момент. Может быть null.
идентификатор задания	нить	Идентификатор задания обновления. Может быть null.
отметка времени	целое число	Отметка времени завершения задания обновления. Значение nullозначает, что задание все еще выполняется. Может быть null.
продолжительность	целое число	Продолжительность обновления в миллисекундах. Может быть null.
целевая версия	нить	Целевая версия обновления. Укажите версию в <major>.<minor>.<revision>.<timestamp>формате. Чтобы обновить до последней доступной версии, используйте latestзначение.
ошибка	нить	Информация об ошибке обновления. Может быть null.

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

{
  "allUpdateJobs": [
    {
      "agId": "0x3efdd092",
      "updateJobs": [
        {
          "jobState": "SUCCEED",
          "updateMethod": "AUTOMATIC",
          "updateType": "ACTIVE_GATE",
          "agType": "ENVIRONMENT",
          "startVersion": "1.185.0.20200201-120000",
          "environments": [
            "string"
          ],
          "cancelable": false,
          "jobId": "-3524498778810258605",
          "timestamp": 1582031917814,
          "duration": 3608000,
          "targetVersion": "1.190.0.20200301-130000",
          "error": "string"
        }
      ]
    }
  ]
}