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|Эндп...») |
Нет описания правки |
||
| Строка 1: | Строка 1: | ||
'''''[[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 Ключ-АСТРОМ#.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|АктивныеШлюзы]] / Задания автообновлений / DELETE задание обновления''''' | '''''[[API Ключ-АСТРОМ|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 Ключ-АСТРОМ#.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|АктивныеШлюзы]] / Задания автообновлений / DELETE задание обновления''''' | ||
Удаляет указанное задание автоматического обновления АктивногоШлюза. | Удаляет указанное задание автоматического обновления АктивногоШлюза. | ||
| Строка 56: | Строка 56: | ||
Токен API передается в заголовке авторизации . | Токен API передается в заголовке авторизации . | ||
====Curl==== | ====Curl==== | ||
< | <curl -L -X DELETE '<nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/1812885988/updateJobs/-7240069678607892845'</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code> | ||
====URL запроса==== | ====URL запроса==== | ||
<code><nowiki>https://mySampleEnv.live. | <code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/1812885988/updateJobs/-7240069678607892845</nowiki></code> | ||
====Код ответа==== | ====Код ответа==== | ||
204 | 204 | ||
Версия от 18:58, 23 декабря 2024
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.AppOptima.com/api/v2/activeGates/1812885988/updateJobs/-7240069678607892845' \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL запроса
https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/1812885988/updateJobs/-7240069678607892845
Код ответа
204