POST задание автообновления
API Ключ-АСТРОМ / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / POST задание автообновления
Создает новое задание автоматического обновления для указанного АктивногоШлюза.
Задание обновляет АктивныйШлюз до указанной версии. Вы можете получить список доступных версий с помощью вызова GET доступных версий АктивногоШлюза .
Запрос потребляет и производит application/json
полезную нагрузку.
POST | 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.write
), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | необходимость |
---|---|---|---|---|
старение | string | ID необходимого АктивногоШлюза. | path | по желанию |
body | Обновить задание | Тело запроса в формате JSON, содержащее параметры задания обновления. | body | обязательный |
Объекты тела запроса
объект UpdateJob
Конфигурация задания обновления АктивногоШлюза.
Элемент | Тип | Описание | необходимые |
---|---|---|---|
jobState | string | Статус задания обновления.
Элемент может содержать эти значения
|
по желанию |
updateMethod | string | Метод обновления АктивногоШлюза или его компонента.
Элемент может содержать эти значения
|
по желанию |
updateType | string | Компонент, который нужно обновить.
Элемент может содержать эти значения
|
по желанию |
agType | string | Тип АктивныйШлюз.
Элемент может содержать эти значения
|
по желанию |
startVersion | string | Первоначальная версия АктивныйШлюз. | по желанию |
окружающая среда | string [] | Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться. | по желанию |
отменяемый | логический | В настоящий момент задание можно ( true ) или нельзя ( false ) отменить.
|
по желанию |
jobId | string | Идентификатор задания обновления. | по желанию |
отметка времени | целое число | Отметка времени завершения задания обновления.
|
по желанию |
продолжительность | целое число | Продолжительность обновления в миллисекундах. | по желанию |
targetVersion | string | Целевая версия обновления.
Укажите версию в Чтобы обновить до последней доступной версии, используйте |
обязательный |
ошибка | string | Информация об ошибке обновления. | по желанию |
Модель JSON тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"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"
}
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
201 | Обновить задание | Успех. Обновление-задание создано. |
400 | Конверт ошибки | Не удалось. Введены неверные данные. |
Объекты тела ответа
объект UpdateJob
Конфигурация задания обновления АктивногоШлюза.
Элемент | Тип | Описание | необходимые |
---|---|---|---|
jobState | string | Статус задания обновления.
Элемент может содержать эти значения
|
по желанию |
updateMethod | string | Метод обновления АктивныйШлюз или его компонента.
Элемент может содержать эти значения
|
по желанию |
updateType | string | Компонент, который нужно обновить.
Элемент может содержать эти значения
|
по желанию |
agType | string | Тип АктивныйШлюз.
Элемент может содержать эти значения
|
по желанию |
startVersion | string | Первоначальная версия АктивногоШлюза. | по желанию |
окружающая среда | string [] | Список сред (заданных идентификаторами), к которым АктивныйШлюз может подключиться. | по желанию |
отменяемый | логический | В настоящий момент задание можно ( true ) или нельзя ( false ) отменить.
|
по желанию |
jobId | string | Идентификатор задания обновления. | по желанию |
отметка времени | целое число | Отметка времени завершения задания обновления.
|
по желанию |
продолжительность | целое число | Продолжительность обновления в миллисекундах. | по желанию |
targetVersion | string | Целевая версия обновления.
Укажите версию в Чтобы обновить до последней доступной версии, используйте |
обязательный |
ошибка | string | Информация об ошибке обновления. | по желанию |
Модель JSON тела ответа
{
"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"
}
Проверить полезную нагрузку
Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.
Запрос потребляет application/json
полезную нагрузку.
POST | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на запись АктивныхШлюзов ( activeGates.write
), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
204 | - | Подтверждено. Отправленное задание на обновление действительно. У ответа нет тела. |
400 | Конверт ошибки | Не удалось. Введены неверные данные. |
Пример
В этом примере запрос создает задание обновления для обновления АктивногоШлюза с идентификатором 1812885988 до версии 1.198.0.20200630-163221 .
Токен API передается в заголовке авторизации .
Curl
curl -L -X POST 'https://mySampleEnv.live.astromkey.ru/api/v2/activeGates/1812885988/updateJobs' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
"targetVersion": "1.198.0.20200630-163221"
}'
URL запроса
https://mySampleEnv.live.astromkey.ru/api/v2/activeGates/1812885988/updateJobs
Тело запроса
{
"targetVersion": "1.198.0.20200630-163221"
}
Тело ответа
{
"jobId": "-7240069678607892845",
"jobState": "PENDING",
"updateMethod": null,
"updateType": null,
"cancelable": true,
"startVersion": "1.195.5.20200522-174041",
"targetVersion": "1.198.0.20200630-163221",
"timestamp": null,
"agType": "ENVIRONMENT",
"environments": [
"mySampleEnv"
],
"error": null,
"duration": null
}
Код ответа
201