GET АктивныхШлюзов с автообновлением заданий: различия между версиями

Текущая версия от 09:29, 26 декабря 2024

API АппОптима / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / GET АктивныхШлюзов с автообновлением заданий

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

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

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

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/updateJobs`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/updateJobs`

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
from	string	Начало запрошенного периода времени для заданий обновления. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах 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 день.	запрос	необязательный
to	string	Конец запрошенного периода времени для заданий обновления. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах 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	string	Фильтрует результирующий набор заданий обновления по указанной исходной версии. Укажите здесь оператор сравнения. Элемент может содержать эти значения `EQUAL` `GREATER` `GREATER_EQUAL` `LOWER` `LOWER_EQUAL`	запрос	необязательный
стартовая версия	string	Фильтрует результирующий набор update-jobs по начальной версии (обязательный формат `<major>.<minor>.<revision>`).	запрос	необязательный
тип обновления	string	Фильтрует результирующий набор заданий обновления по типу обновления. Элемент может содержать эти значения `ACTIVE_GATE` `REMOTE_PLUGIN_AGENT` `SYNTHETIC` `Z_REMOTE`	запрос	необязательный
targetVersionCompareType	string	Фильтрует результирующий набор заданий обновления по указанной целевой версии. Укажите здесь оператор сравнения. Элемент может содержать эти значения `EQUAL` `GREATER` `GREATER_EQUAL` `LOWER` `LOWER_EQUAL`	запрос	необязательный
целевая версия	string	Фильтрует результирующий набор заданий обновления по целевой версии (обязательный формат `<major>.<minor>.<revision>`).	запрос	необязательный
последние обновления	логический	Если `true`, результирующий набор заданий обновления отфильтровывается до самого последнего обновления каждого типа.	запрос	необязательный

Ответ

Коды ответов

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

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

Объект `UpdateJobsAll`

Список АктивныхШлюзов с заданиями на обновление.

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

Объект `UpdateJobList`

Список заданий обновления АктивногоШлюза.

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

Объект `UpdateJob`

Настройка задания обновления АктивногоШлюза.

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

@@ Строка 1: / Строка 1: @@
-'''''[[API АппОптима]] / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / GET АктивныхШлюзов с автообновлением заданий'''''
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%D0%BA%D0%BE%D0%B4-,%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D1%8B%D0%B5%D0%A8%D0%BB%D1%8E%D0%B7%D1%8B,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C АктивныеШлюзы] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%97%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%B0%D0%B2%D1%82%D0%BE%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B9 Задания автообновлений] / GET АктивныхШлюзов с автообновлением заданий'''''
 Список всех АктивныхШлюзов, у которых есть задания автоматического обновления. В список входят выполненные задания (успешные или неуспешные) и выполняемые задания.
@@ Строка 8: / Строка 8: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/updateJobs</nowiki></code>
 |-
@@ Строка 279: / Строка 279: @@
       }
     ]
-  }</code>
+  }