удаление-кластера

Описание

Удаляет указанный кластер. Кластер переходит в состояние INACTIVE. Кластеры со статусом INACTIVE могут оставаться доступными в вашей учетной записи в течение некоторого времени. Однако данное поведение может измениться в будущем. Мы не рекомендуем полагаться на сохранение кластеров со статусом INACTIVE.

Вы должны отрегистрировать все контейнерные экземпляры из этого кластера перед его удалением. Вы можете перечислить контейнерные экземпляры в кластере с помощью ListContainerInstances и отрегистрировать их с помощью DeregisterContainerInstance .

См. также: Документацию API AWS

Синтаксис

  delete-cluster
--cluster <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--cluster (строка)

Короткое имя или полное имя Amazon Resource Name (ARN) кластера для удаления.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставляемому --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. При отсутствии значения или значении input выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если задано значение output, он проверит входные данные команды и вернёт пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в генерируемом JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладочную запись журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (булево)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

on
off
auto

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл сертификата CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться в режиме блокировки без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться в режиме блокировки без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как base64-кодированная строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается в двоичном блоке, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла непосредственно, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключить вывод пагинатора CLI.

--cli-auto-prompt (булево)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы входных параметров CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию можно найти в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для удаления пустого кластера

Следующий пример удаляет указанный пустой кластер.

aws ecs delete-cluster --cluster MyCluster

Вывод:

{
    "cluster": {
        "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
        "status": "INACTIVE",
        "clusterName": "MyCluster",
        "registeredContainerInstancesCount": 0,
        "pendingTasksCount": 0,
        "runningTasksCount": 0,
        "activeServicesCount": 0
        "statistics": [],
        "tags": []
    }
}

Дополнительную информацию см. в разделе Удаление кластера в Руководстве разработчика Amazon ECS.

Вывод

кластер -> (структура)

Полное описание удаленного кластера.

clusterArn -> (строка)

Amazon Resource Name (ARN), идентифицирующий кластер. Дополнительную информацию о формате ARN см. в разделе Amazon Resource Name (ARN) в руководстве Amazon ECS Developer Guide.

clusterName -> (строка)

Строка, сгенерированная пользователем, используемая для идентификации кластера.

configuration -> (структура)

Конфигурация команды выполнения и управляемого хранилища для кластера.

executeCommandConfiguration -> (структура)

Подробности конфигурации команды выполнения.

kmsKeyId -> (строка)

Укажите идентификатор ключа управления ключами (Key Management Service), чтобы зашифровать данные между локальным клиентом и контейнером.

logging -> (строка)

Настройка ведения журнала для перенаправления журналов результатов команды выполнения. Доступны следующие настройки ведения журнала.

NONE : Сессия выполнения команды не регистрируется.
DEFAULT : Используется конфигурация awslogs в определении задачи. Если параметр ведения журнала не указан, используется это значение по умолчанию. Если драйвер ведения журнала awslogs не настроен в определении задачи, вывод не будет записан в журнал.
OVERRIDE : Укажите детали ведения журнала как часть logConfiguration. Если указан параметр ведения журнала OVERRIDE, требуется logConfiguration.

logConfiguration -> (структура)

Настройка ведения журнала результатов действий команды выполнения. Журналы могут отправляться в CloudWatch Logs или в ведро Amazon S3. При указании logging=OVERRIDE, необходимо указать logConfiguration.

cloudWatchLogGroupName -> (строка)

Имя группы журналов CloudWatch для отправки журналов.

Примечание

Группа журналов CloudWatch должна быть уже создана.

cloudWatchEncryptionEnabled -> (булево)

Определяет, использовать ли шифрование для журналов CloudWatch. Если не указано, шифрование отключено.

s3BucketName -> (строка)

Имя ведра S3 для отправки журналов.

Примечание

Ведро S3 должно быть уже создано.

s3EncryptionEnabled -> (булево)

Определяет, использовать ли шифрование для журналов S3. Если не указано, шифрование не используется.

s3KeyPrefix -> (строка)

Необязательная папка в ведре S3 для размещения журналов.

managedStorageConfiguration -> (структура)

Подробности конфигурации управляемого хранилища.

kmsKeyId -> (строка)

Укажите идентификатор ключа управления ключами (Key Management Service) для шифрования управляемого хранилища Amazon ECS.

Когда вы указываете kmsKeyId, Amazon ECS использует ключ для шифрования томов данных, управляемых Amazon ECS, которые подключены к задачам в кластере. Следующие тома данных управляются Amazon ECS: Amazon EBS. Дополнительную информацию о шифровании томов Amazon EBS, подключенных к задачам Amazon ECS, см. в разделе Зашифровать данные, хранящиеся в томах Amazon EBS для Amazon ECS в руководстве Amazon Elastic Container Service Developer Guide.

Ключ должен быть ключом одной области.

fargateEphemeralStorageKmsKeyId -> (строка)

Укажите идентификатор ключа управления ключами (Key Management Service) для временного хранилища Fargate.

Когда вы указываете fargateEphemeralStorageKmsKeyId, Amazon Web Services Fargate использует ключ для шифрования данных в состоянии покоя в временном хранилище. Дополнительную информацию о шифровании временного хранилища Fargate см. в разделе Управление ключами для временного хранилища Amazon Web Services Fargate для Amazon ECS в руководстве Amazon Elastic Container Service Developer Guide.

Ключ должен быть ключом одной области.

status -> (строка)

Статус кластера. Возможные состояния:

ACTIVE

Кластер готов к приему задач, и при необходимости вы можете зарегистрировать узлы контейнеров в кластере.

PROVISIONING

Кластер имеет поставщиков емкости, связанные с ним, и ресурсы, необходимые для поставщика емкости, создаются.

DEPROVISIONING

Кластер имеет поставщиков емкости, связанные с ним, и ресурсы, необходимые для поставщика емкости, удаляются.

FAILED

Кластер имеет поставщиков емкости, связанные с ним, и ресурсы, необходимые для поставщика емкости, не удалось создать.

INACTIVE

Кластер был удален. Кластеры со статусом INACTIVE могут оставаться доступными в вашей учетной записи в течение некоторого времени. Однако это поведение может измениться в будущем. Не рекомендуется полагаться на сохранение кластеров со статусом INACTIVE.

registeredContainerInstancesCount -> (целое число)

Количество узлов контейнеров, зарегистрированных в кластере. Это включает узлы контейнеров в статусах ACTIVE и DRAINING.

runningTasksCount -> (целое число)

Количество задач в кластере, находящихся в состоянии RUNNING.

pendingTasksCount -> (целое число)

Количество задач в кластере, находящихся в состоянии PENDING.

activeServicesCount -> (целое число)

Количество служб, работающих в кластере в состоянии ACTIVE. Вы можете просмотреть эти службы с помощью PListServices.

statistics -> (список)

Дополнительная информация о ваших кластерах, разделенных по типу запуска. Включает:

runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount

(структура)

Объект пар ключ-значение.

name -> (строка)

Имя пары ключ-значение. Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары ключ-значение. Для переменных среды это значение переменной среды.

tags -> (список)

Метаданные, которые вы применяете к кластеру, чтобы помочь в категоризации и организации. Каждый тег состоит из ключа и необязательного значения. Оба вы определяете.

Применяются следующие основные ограничения к тегам:

Максимальное количество тегов на ресурс - 50
Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
Максимальная длина ключа - 128 символов Юникода в UTF-8
Максимальная длина значения - 256 символов Юникода в UTF-8
Если ваша схема тегов используется в нескольких службах и ресурсах, помните, что другие службы могут иметь ограничения на допустимые символы. В целом, разрешены буквы, цифры и пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
Ключи и значения тегов чувствительны к регистру.
Не используйте aws:, AWS: или любые комбинации верхнего и нижнего регистра этих префиксов для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете изменять или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете количества тегов на ресурс.

(структура)

Метаданные, которые вы применяете к ресурсу, чтобы помочь в категоризации и организации. Каждый тег состоит из ключа и необязательного значения. Вы определяете их.

Применяются следующие основные ограничения к тегам:

Максимальное количество тегов на ресурс - 50
Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
Максимальная длина ключа - 128 символов Юникода в UTF-8
Максимальная длина значения - 256 символов Юникода в UTF-8
Если ваша схема тегов используется в нескольких службах и ресурсах, помните, что другие службы могут иметь ограничения на допустимые символы. В целом, разрешены буквы, цифры и пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
Ключи и значения тегов чувствительны к регистру.
Не используйте aws:, AWS: или любые комбинации верхнего и нижнего регистра этих префиксов для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете изменять или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете количества тегов на ресурс.

key -> (строка)

Одна часть пары ключ-значение, составляющей тег. Ключ - это общая метка, которая действует как категория для более конкретных значений тега.

value -> (строка)

Необязательная часть пары ключ-значение, составляющей тег. Значение действует как описание в категории тега (ключ).

settings -> (список)

Настройки кластера. Этот параметр указывает, включен или выключен CloudWatch Container Insights для кластера.

(структура)

Настройки для создания кластера. Этот параметр используется для включения CloudWatch Container Insights с расширенной наблюдаемостью или CloudWatch Container Insights для кластера.

CloudWatch Container Insights с расширенной наблюдаемостью предоставляет все метрики Container Insights, а также дополнительные метрики задач и контейнеров. Эта версия поддерживает расширенную наблюдаемость для кластеров Amazon ECS, использующих типы запуска Amazon EC2 и Fargate. После настройки Container Insights с расширенной наблюдаемостью на Amazon ECS Container Insights автоматически собирает подробные телеметрические данные инфраструктуры с уровня кластера до уровня контейнера в вашей среде и отображает эти критические данные производительности в подготовленных панелях управления, устраняя сложную настройку наблюдаемости.

Дополнительную информацию см. в разделе Отслеживание контейнеров Amazon ECS с помощью Container Insights с расширенной наблюдаемостью в руководстве Amazon Elastic Container Service Developer Guide.

name -> (строка)

Имя настройки кластера. Значение - containerInsights.

value -> (строка)

Значение для настройки кластера. Поддерживаемые значения - enhanced, enabled и disabled.

Для использования Container Insights с расширенной наблюдаемостью, установите настройку учетной записи containerInsights в enhanced.

Для использования Container Insights, установите настройку учетной записи containerInsights в enabled.

Если значение кластера указано, оно переопределит значение containerInsights, установленное с помощью PutAccountSetting или PutAccountSettingDefault.

capacityProviders -> (список)

Поставщики емкости, связанные с кластером.

(строка)

defaultCapacityProviderStrategy -> (список)

Стратегия поставщика емкостей по умолчанию для кластера. При запуске служб или задач в кластере без указания типа запуска или стратегии поставщика емкостей используется стратегия поставщика емкостей по умолчанию.

(структура)

Подробности стратегии поставщика емкостей. Стратегию поставщика емкостей можно задать при использовании API RunTask или CreateCluster или в качестве стратегии поставщика емкостей по умолчанию для кластера с помощью API CreateCluster.

В стратегии поставщика емкостей можно использовать только поставщиков емкостей, которые уже связаны с кластером и имеют состояние ACTIVE или UPDATING. Для связывания поставщика емкостей с кластером используется API PutClusterCapacityProviders.

Если используется поставщик емкостей, использующий группу Auto Scaling, поставщик емкостей должен быть уже создан. Новые поставщики емкостей группы Auto Scaling можно создать с помощью операции API CreateClusterCapacityProvider.

Для использования поставщика емкостей Fargate укажите либо поставщиков емкостей FARGATE или FARGATE_SPOT. Поставщики емкостей Fargate доступны для всех учетных записей и должны быть связаны с кластером, чтобы их можно было использовать в стратегии поставщика емкостей.

С помощью FARGATE_SPOT можно запускать задачи, устойчивые к прерываниям, со скидкой по сравнению с ценой FARGATE. FARGATE_SPOT запускает задачи на свободных вычислительных ресурсах. Когда Amazon Web Services нуждается в этих ресурсах, ваши задачи прерываются с двухминутным предупреждением. FARGATE_SPOT поддерживает задачи Linux с архитектурой X86_64 на платформе версии 1.3.0 или выше. FARGATE_SPOT поддерживает задачи Linux с архитектурой ARM64 на платформе версии 1.4.0 или выше.

Стратегия поставщика емкостей может содержать не более 20 поставщиков емкостей.

capacityProvider -> (строка)

Короткое имя поставщика емкостей.

weight -> (целое число)

Значение weight определяет относительный процент от общего числа запускаемых задач, которые должны использовать указанного поставщика емкостей. Значение weight учитывается после значения base, если оно определено.

Если значение weight не указано, используется значение по умолчанию 0. Если в стратегии поставщика емкостей указаны несколько поставщиков емкостей, по крайней мере один из поставщиков емкостей должен иметь значение weight больше нуля, а любые поставщики емкостей с весом 0 не могут использоваться для размещения задач. Если вы указываете в стратегии несколько поставщиков емкостей, у которых все значения weight равны 0, любые действия RunTask или CreateService, использующие стратегию поставщика емкостей, завершатся ошибкой.

Пример сценария использования весов: определение стратегии, содержащей двух поставщиков емкостей, у обоих которых значение weight равно 1, тогда, когда условие base выполнено, задачи будут распределены равномерно между двумя поставщиками емкостей. Используя тот же принцип, если вы зададите значение weight равное 1 для capacityProviderA и значение weight равное 4 для capacityProviderB, тогда на каждую задачу, запущенную с помощью capacityProviderA, четыре задачи будут использоваться с capacityProviderB.

base -> (целое число)

Значение base определяет минимальное количество задач, которые необходимо запустить на указанном поставщике емкостей. Только один поставщик емкостей в стратегии поставщика емкостей может иметь заданное значение base. Если значение не указано, используется значение по умолчанию 0.

attachments -> (список)

Ресурсы, присоединенные к кластеру. При использовании поставщика емкостей с кластером поставщик емкостей и связанные ресурсы возвращаются в виде прикреплений к кластеру.

(структура)

Объект, представляющий прикрепление экземпляра контейнера или задачи.

id -> (строка)

Уникальный идентификатор прикрепления.

type -> (строка)

Тип прикрепления, такой как ElasticNetworkInterface, Service Connect и AmazonElasticBlockStorage.

status -> (строка)

Состояние прикрепления. Допустимые значения: PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED и FAILED.

details -> (список)

Подробности прикрепления.

Для интерфейсов эластичной сети это включает идентификатор интерфейса сети, MAC-адрес, идентификатор подсети и частный IPv4-адрес.

Для служб Service Connect это включает portName, clientAliases, discoveryName и ingressPortOverride.

Для Elastic Block Storage это включает roleArn, deleteOnTermination, volumeName, volumeId и statusReason (только при сбое создания или прикрепления прикрепления).

(структура)

Объект пары «ключ-значение».

name -> (строка)

Имя пары «ключ-значение». Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары «ключ-значение». Для переменных среды это значение переменной среды.

attachmentsStatus -> (строка)

Состояние поставщиков емкостей, связанных с кластером. Ниже приведены состояния, которые возвращаются.

UPDATE_IN_PROGRESS

Доступные поставщики емкостей для кластера обновляются.

UPDATE_COMPLETE

Поставщики емкостей успешно обновлены.

UPDATE_FAILED

Обновление поставщика емкостей завершилось неудачей.

serviceConnectDefaults -> (структура)

Используйте этот параметр для установки пространства имен Service Connect по умолчанию. После установки пространства имен Service Connect по умолчанию все новые службы с включенным Service Connect, созданные в кластере, добавляются как клиентские службы в этом пространстве имен. Это значение применяется только к новым службам, которые устанавливают параметр enabled в значение true в ServiceConnectConfiguration. Вы можете установить пространство имен каждой службы индивидуально в ServiceConnectConfiguration, чтобы переопределить этот параметр по умолчанию.

Задачи, выполняемые в пространстве имен, могут использовать короткие имена для подключения к службам в этом пространстве имен. Задачи могут подключаться к службам во всех кластерах в пространстве имен. Подключение осуществляется через управляемый контейнер-прокси, который собирает журналы и метрики для повышения видимости. Поддерживаются только задачи, созданные службами Amazon ECS. Дополнительные сведения см. в разделе Service Connect в руководстве разработчика Amazon Elastic Container Service.

namespace -> (строка)

Имя пространства имен или полный Amazon Resource Name (ARN) пространства имен Cloud Map. Это пространство имен используется, когда вы создаёте службу и не указываете конфигурацию Service Connect.

END_OF_DOCUMENT_MARKER