DELETE задание автообновления
Материал из Документация Ключ-АСТРОМ
Версия от 20:30, 2 июня 2024; ENetrebin (обсуждение | вклад) (Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»)
API Ключ-АСТРОМ / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / DELETE задание обновления
Удаляет указанное задание автоматического обновления АктивногоШлюза.
| DELETE | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на запись АктивныхШлюзов( activeGates.write), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | необходимые |
|---|---|---|---|---|
| старение | string | ID необходимого АктивногоШлюза. | дорожка | по желанию |
| jobId | string | Уникальный идентификатор задания обновления АктивногоШлюза. | дорожка | по желанию |
Параметры
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 204 | - | Успех. Задание на обновление было удалено. У ответа нет тела. |
| 400 | Конверт ошибки | Не удалось. Введены неверные данные. |
| 404 | Конверт ошибки | Не найден. См. Подробности в теле ответа. |
Ответ
В этом примере запрос удаляет задание обновления с идентификатором -7240069678607892845 из АктивногоШлюза с идентификатором 1812885988 . Код ответа 204 указывает на то, что удаление прошло успешно.
Токен API передается в заголовке авторизации .
Curl
curl -L -X DELETE 'https://mySampleEnv.live.astromkey.com/api/v2/activeGates/1812885988/updateJobs/-7240069678607892845' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL запроса
https://mySampleEnv.live.astromkey.com/api/v2/activeGates/1812885988/updateJobs/-7240069678607892845
Код ответа
204
