Нет описания правки |
Нет описания правки |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 1: | Строка 1: | ||
'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v2]] / [[API Кластера v2|Окружения]] / Удаление окружения''''' | |||
Этот вызов API удаляет указанную среду. Среда должна быть отключена, прежде чем ее можно будет удалить. | Этот вызов API удаляет указанную среду. Среда должна быть отключена, прежде чем ее можно будет удалить. | ||
==Аутентификация== | ==Аутентификация== | ||
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. | Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера. | ||
==Конечная точка== | ==Конечная точка== | ||
<code>/api/cluster/v2/environments</code> | <code>/api/cluster/v2/environments</code> | ||
Текущая версия от 16:52, 6 января 2025
Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v2 / Окружения / Удаление окружения
Этот вызов API удаляет указанную среду. Среда должна быть отключена, прежде чем ее можно будет удалить.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/cluster/v2/environments
Параметры
| Параметр | Тип | Описание | В | Обязательно |
|---|---|---|---|---|
| id | string | Идентификатор среды для удаления.
Если вы также устанавливаете идентификатор в теле сообщения, он должен совпадать с этим идентификатором. |
path | Да |
Ответ
Коды ответа
| Code | Описание |
|---|---|
| 204 | Удалено. Ответ не имеет тела. |
| 400 | Не удалось. Например, если среда не отключена. |
Пример
Удаляет среду 19a963a7-b19f-4382-964a-4df674c8eb8e.
Curl
curl -X DELETE "https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e" -H "accept: */*" -H "Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890"
URL-адрес запроса
https://myManaged.cluster.com/api/cluster/v2/environments/19a963a7-b19f-4382-964a-4df674c8eb8e
Тело ответа
Ответ не имеет тела.
Код ответа
204