GET все задания автообновления

Материал из Документация Ключ-АСТРОМ

API Ключ-АСТРОМ / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / GET глобальную конфигурацию

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

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

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

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

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

Параметры

Параметр Тип Описание In необходимость
старение string ID необходимого АктивногоШлюза. path по желанию
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-1w).

Максимальный срок - 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
 запрос обязательный
startVersion string Фильтрует полученный набор обновлений по исходной версии (требуемый формат <major>.<minor>.<revision>). запрос обязательный
updateType string Фильтрует результирующий набор обновлений по типу обновления.

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

  • ACTIVE_GATE
  • REMOTE_PLUGIN_AGENT
  • SYNTHETIC
  • Z_REMOTE
 запрос обязательный
targetVersionCompareType string Фильтрует полученный набор заданий обновления по указанной целевой версии.

Укажите здесь оператор сравнения.

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

  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL
 запрос обязательный
targetVersion string Фильтрует результирующий набор обновлений по целевой версии (требуемый формат <major>.<minor>.<revision>). запрос обязательный
lastUpdates логический Если true, фильтрует результирующий набор заданий обновления до самых последних обновлений каждого типа. запрос обязательный

Ответ

Коды ответов

Код Тип Описание
200 Обновить список вакансий Успех
404 Конверт ошибки Не найден. См. Подробности в теле ответа.

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

объект UpdateJobList

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

Элемент Тип Описание необходимость
старение string Идентификатор АктивногоШлюза. по желанию
updateJobs Обновить задание [] Список обновлений АктивногоШлюза. по желанию

объект UpdateJob

Конфигурация задания обновления АктивногоШлюза.

Элемент Тип Описание необходимость
jobState string Статус задания обновления.

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

  • FAILED
  • IN_PROGRESS
  • PENDING
  • ROLLBACK
  • SCHEDULED
  • SKIPPED
  • SUCCEED
 по желанию
updateMethod string Метод обновления АктивногоШлюза или его компонента.

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

  • AUTOMATIC
  • MANUAL_INSTALLATION
  • ON_DEMAND
 по желанию
updateType string Компонент, который нужно обновить.

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

  • ACTIVE_GATE
  • REMOTE_PLUGIN_AGENT
  • SYNTHETIC
  • Z_REMOTE
 по желанию
agType string Тип АктивногоШлюза.

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

  • CLUSTER
  • ENVIRONMENT
  • ENVIRONMENT_MULTI
 по желанию
startVersion string Первоначальная версия АктивногоШлюза. по желанию
среда string [] Список сред (заданных идентификаторами), к которым АктивногоШлюза может подключиться. по желанию
отменяемый логический В настоящий момент задание можно ( true) или нельзя ( false) отменить. по желанию
jobId string Идентификатор задания обновления. по желанию
отметка времени целое число Отметка времени завершения задания обновления.

nullЗначение означает , что работа по - прежнему работает.

по желанию
продолжительность целое число Продолжительность обновления в миллисекундах. по желанию
targetVersion string Целевая версия обновления.

Укажите версию в <major>.<minor>.<revision>.<timestamp>формате.

Чтобы обновить до последней доступной версии, используйте latestзначение.

обязательный
ошибка string Информация об ошибке обновления. по желанию

Модель JSON тела ответа

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

Пример

В этом примере в запросе перечислены все задания автоматического обновления АктивногоШлюза с идентификатором 2100855201 .

Токен API передается в заголовке авторизации .

Curl

curl -L -X GET 'https://mySampleEnv.live.astromkey.com/api/v2/activeGates/2100855201/updateJobs' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL запроса

https://mySampleEnv.live.astromkey.com/api/v2/activeGates/2100855201/updateJobs

Тело ответа

{
  "agId": "2100855201",
  "updateJobs": [
    {
      "jobId": "-3137933319273211278",
      "jobState": "SUCCEED",
      "updateMethod": "MANUAL_INSTALLATION",
      "updateType": "ACTIVE_GATE",
      "cancelable": false,
      "startVersion": "1.198.0.20200629-221007",
      "targetVersion": "1.198.0.20200630-163221",
      "timestamp": 1593683526719,
      "agType": "ENVIRONMENT",
      "environments": [
        "mySampleEnv"
      ],
      "error": null,
      "duration": 556574
    },
    {
      "jobId": "-6733215466838702651",
      "jobState": "SUCCEED",
      "updateMethod": "AUTOMATIC",
      "updateType": "REMOTE_PLUGIN_AGENT",
      "cancelable": false,
      "startVersion": "1.198.0.20200629-123323",
      "targetVersion": "1.198.0.20200630-155408",
      "timestamp": 1593545522797,
      "agType": "ENVIRONMENT",
      "environments": [
        "mySampleEnv"
      ],
      "error": null,
      "duration": 42669
    }
  ]
}

Код ответа

200

Источник — https://doc.ruscomtech.ru/index.php?title=GET_все_задания_автообновления&oldid=3572