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|Эндп...») |
Нет описания правки |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
'''''[[API | '''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%D0%BA%D0%BE%D0%B4-,%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,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C АктивныеШлюзы] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%97%D0%B0%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F%20%D0%B0%D0%B2%D1%82%D0%BE%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B9 Задания автообновлений] / DELETE задание обновления''''' | ||
Удаляет указанное задание автоматического обновления АктивногоШлюза. | Удаляет указанное задание автоматического обновления АктивногоШлюза. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |DELETE | | rowspan="2" |DELETE | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code> | ||
|- | |- | ||
| Строка 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' | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' | ||
====URL запроса==== | ====URL запроса==== | ||
<code><nowiki>https://mySampleEnv.live. | <code><nowiki>https://mySampleEnv.live.AppOptima.com/api/v2/activeGates/1812885988/updateJobs/-7240069678607892845</nowiki></code> | ||
====Код ответа==== | ====Код ответа==== | ||
204 | 204 | ||
Текущая версия от 14:10, 24 декабря 2024
API АппОптима / Эндпойнты среды / АктивныеШлюзы / Задания автообновлений / DELETE задание обновления
Удаляет указанное задание автоматического обновления АктивногоШлюза.
| DELETE | АппОптима | 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