GET АктивныхШлюзов с автообновлением заданий
API Ключ-АСТРОМ / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / GET АктивныхШлюзов с автообновлением заданий
Список всех АктивныхШлюзов, у которых есть задания автоматического обновления. В список входят выполненные задания (успешные или неуспешные) и выполняемые задания.
Вы можете сузить вывод, указав параметры фильтрации в своем запросе.
Запрос создает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/updateJobs
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/updateJobs
|
Аутентификация
Для выполнения этого запроса вам необходимо разрешение Read АктивныхШлюзов ( activeGates.read
) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
from | string | Начало запрошенного периода времени для заданий обновления.
Вы можете использовать один из следующих форматов:
Если не задано, используется относительный таймфрейм в один день ( Максимальный срок 31 день. |
запрос | необязательный |
to | string | Конец запрошенного периода времени для заданий обновления.
Вы можете использовать один из следующих форматов:
Если не установлено, используется текущая метка времени. |
запрос | необязательный |
startVersionCompareType | string | Фильтрует результирующий набор заданий обновления по указанной исходной версии.
Укажите здесь оператор сравнения. Элемент может содержать эти значения
|
запрос | необязательный |
стартовая версия | string | Фильтрует результирующий набор update-jobs по начальной версии (обязательный формат <major>.<minor>.<revision> ).
|
запрос | необязательный |
тип обновления | string | Фильтрует результирующий набор заданий обновления по типу обновления.
Элемент может содержать эти значения
|
запрос | необязательный |
targetVersionCompareType | string | Фильтрует результирующий набор заданий обновления по указанной целевой версии.
Укажите здесь оператор сравнения. Элемент может содержать эти значения
|
запрос | необязательный |
целевая версия | string | Фильтрует результирующий набор заданий обновления по целевой версии (обязательный формат <major>.<minor>.<revision> ).
|
запрос | необязательный |
последние обновления | логический | Если true , результирующий набор заданий обновления отфильтровывается до самого последнего обновления каждого типа.
|
запрос | необязательный |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | Обновить Вакансии Все | Успех |
400 | Конверт ошибки | Не удалось. Ввод недействителен. |
Объекты тела ответа
Объект UpdateJobsAll
Список АктивныхШлюзов с заданиями на обновление.
Элемент | Тип | Описание |
---|---|---|
всеобновитьработы | Обновить список заданий [] | Список АктивныхШлюзов с заданиями на обновление.
Может быть |
Объект UpdateJobList
Список заданий обновления АктивногоШлюза.
Элемент | Тип | Описание |
---|---|---|
agId | string | Идентификатор АктивногоШлюза.
Может быть |
обновлениеJobs | Обновить задание [] | Список заданий обновления АктивногоШлюза.
Может быть |
Объект UpdateJob
Настройка задания обновления АктивногоШлюза.
Элемент | Тип | Описание |
---|---|---|
jobState | string | Статус задания обновления.
Элемент может содержать эти значения
Может быть |
метод обновления | string | Способ обновления АктивногоШлюза или его компонентов.
Элемент может содержать эти значения
Может быть |
тип обновления | string | Компонент, который нужно обновить.
Элемент может содержать эти значения
Может быть |
agType | string | Тип АктивногоШлюза.
Элемент может содержать эти значения
Может быть |
стартовая версия | string | Начальная версия АктивногоШлюза.
Может быть |
среды | string [] | Список сред (определяемых идентификаторами), к которым может подключаться АктивныйШлюз.
Может быть |
отменяемый | логический | Задание может ( true ) или не может ( false ) быть отменено в данный момент.
Может быть |
идентификатор задания | string | Идентификатор задания обновления.
Может быть |
отметка времени | целое число | Отметка времени завершения задания обновления.
Значение Может быть |
продолжительность | целое число | Продолжительность обновления в миллисекундах.
Может быть |
целевая версия | string | Целевая версия обновления.
Укажите версию в Чтобы обновить до последней доступной версии, используйте |
ошибка | string | Информация об ошибке обновления.
Может быть |
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"
}
]
}
]
}