Удалить задание автообновления: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| (не показаны 3 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
Удаляет указанное задание автоматического обновления | Удаляет указанное задание автоматического обновления АктивногоШлюза. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |DELETE | ||
| | |Managed | ||
|<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> | ||
|- | |- | ||
|Среда АктивногоШлюза | |||
|Среда | |||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам необходимо разрешение на запись | Чтобы выполнить этот запрос, вам необходимо разрешение на запись АктивныхШлюзов( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация . | ||
== Параметры == | == Параметры == | ||
| Строка 25: | Строка 22: | ||
|стареть | |стареть | ||
|нить | |нить | ||
|ID необходимого | |ID необходимого АктивногоШлюза. | ||
|дорожка | |дорожка | ||
|по желанию | |по желанию | ||
| Строка 31: | Строка 28: | ||
|jobId | |jobId | ||
|нить | |нить | ||
|Уникальный идентификатор задания обновления | |Уникальный идентификатор задания обновления АктивногоШлюза. | ||
|дорожка | |дорожка | ||
|по желанию | |по желанию | ||
| Строка 58: | Строка 55: | ||
== Ответ == | == Ответ == | ||
В этом примере запрос удаляет задание обновления с идентификатором -7240069678607892845 из | В этом примере запрос удаляет задание обновления с идентификатором -7240069678607892845 из АктивногоШлюза с идентификатором 1812885988 . Код ответа 204 указывает на то, что удаление прошло успешно. | ||
Токен API передается в заголовке авторизации . | Токен API передается в заголовке авторизации . | ||
==== | ==== Curl ==== | ||
<code>curl -L -X DELETE '<nowiki>https://mySampleEnv.live. | <code>curl -L -X DELETE '<nowiki>https://mySampleEnv.live.astromkey.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.astromkey.com/api/v2/activeGates/1812885988/updateJobs/-7240069678607892845</nowiki></code> | ||
==== Код ответа ==== | ==== Код ответа ==== | ||
204 | 204 | ||
Текущая версия на 16:26, 3 октября 2023
Удаляет указанное задание автоматического обновления АктивногоШлюза.
| 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. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | В | необходимые |
|---|---|---|---|---|
| стареть | нить | ID необходимого АктивногоШлюза. | дорожка | по желанию |
| jobId | нить | Уникальный идентификатор задания обновления АктивногоШлюза. | дорожка | по желанию |
Параметры
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 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
