delete-task-set

Описание

Удаляет указанный набор задач в рамках службы. Используется, когда служба использует тип контроллера развертывания EXTERNAL. Дополнительную информацию см. в руководстве по типам развертывания Amazon ECS в Руководстве разработчика Amazon Elastic Container Service.

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

Синтаксис

  delete-task-set
--cluster <value>
--service <value>
--task-set <value>
[--force | --no-force]
[--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 (ARN) кластера, который размещает службу, содержащую набор задач, подлежащий удалению.

--service (строка)

Короткое имя или полное имя ресурса Amazon (ARN) службы, содержащей набор задач, подлежащий удалению.

--task-set (строка)

Идентификатор набора задач или полное имя ресурса Amazon (ARN) набора задач, подлежащего удалению.

--force | --no-force (булево)

Если true, вы можете удалить набор задач, даже если он не был уменьшен до нуля.

--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
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

включить
выключить
автоматически

--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-auto-prompt (булево)

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

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

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

Примеры

Примечание

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

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

Для удаления набора задач

Следующий delete-task-set пример демонстрирует, как удалить набор задач. Вы можете включить параметр --force для удаления набора задач, даже если он не был масштабирован до нуля.

aws ecs delete-task-set \
    --cluster MyCluster \
    --service MyService \
    --task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \
    --force

Вывод:

{
    "taskSet": {
        "id": "ecs-svc/1234567890123456789",
        "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
        "status": "DRAINING",
        "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2",
        "computedDesiredCount": 0,
        "pendingCount": 0,
        "runningCount": 0,
        "createdAt": 1557130260.276,
        "updatedAt": 1557130290.707,
        "launchType": "EC2",
        "networkConfiguration": {
            "awsvpcConfiguration": {
                "subnets": [
                    "subnet-12345678"
                ],
                "securityGroups": [
                    "sg-12345678"
                ],
                "assignPublicIp": "DISABLED"
            }
        },
        "loadBalancers": [],
        "serviceRegistries": [],
        "scale": {
            "value": 0.0,
            "unit": "PERCENT"
        },
        "stabilityStatus": "STABILIZING",
        "stabilityStatusAt": 1557130290.707
    }
}

Вывод

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

Подробная информация о наборе задач.

id -> (строка)

Идентификатор набора задач.

taskSetArn -> (строка)

Amazon Resource Name (ARN) набора задач.

serviceArn -> (строка)

Amazon Resource Name (ARN) сервиса, в котором существует набор задач.

clusterArn -> (строка)

Amazon Resource Name (ARN) кластера, в котором существует сервис, содержащий набор задач.

startedBy -> (строка)

Тег, указанный при запуске набора задач. Если набор задач создан развертыванием CodeDeploy, параметр startedBy имеет значение CODE_DEPLOY. Если набор задач создан внешним развертыванием, поле startedBy не используется.

externalId -> (строка)

Внешний идентификатор, связанный с набором задач.

Если набор задач создан развертыванием CodeDeploy, параметр externalId содержит идентификатор развертывания CodeDeploy.

Если набор задач создан для внешнего развертывания и связан с реестром обнаружения сервисов, параметр externalId содержит атрибут ECS_TASK_SET_EXTERNAL_ID Cloud Map.

status -> (строка)

Статус набора задач. Ниже описаны каждый из состояний.

PRIMARY

Набор задач обслуживает трафик производства.

ACTIVE

Набор задач не обслуживает трафик производства.

DRAINING

Задачи в наборе задач останавливаются, а соответствующие целевые объекты удаляются из группы целевых объектов.

taskDefinition -> (строка)

Определения задач, используемых набором задач.

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

Вычисленный желаемый счёт набора задач. Он вычисляется путём умножения desiredCount сервиса на процент scale набора задач. Результат всегда округляется до ближайшего большего целого числа. Например, если вычисленный желаемый счёт равен 1,2, он округляется до 2 задач.

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

Количество задач в наборе задач, находящихся в статусе PENDING во время развертывания. Задача в состоянии PENDING готовится перейти в состояние RUNNING. Набор задач переходит в состояние PENDING, когда он запускается впервые или когда он перезапускается после состояния STOPPED.

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

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

createdAt -> (метка времени)

Unix-метка времени создания набора задач.

updatedAt -> (метка времени)

Unix-метка времени последнего обновления набора задач.

launchType -> (строка)

Тип запуска, используемый задачами в наборе задач. Для получения дополнительной информации см. типы запуска Amazon ECS в руководстве разработчика Amazon Elastic Container Service.

capacityProviderStrategy -> (список)

Стратегия поставщика емкости, связанная с набором задач.

(структура)

Подробности стратегии поставщика емкости. Стратегия поставщика емкости может быть задана при использовании 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 не могут быть использованы для размещения задач. Если вы укажите в стратегии несколько поставщиков емкости, у которых все имеют вес 0, любые действия RunTask или CreateService, использующие стратегию поставщика емкости, завершатся неудачей.

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

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

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

platformVersion -> (строка)

Версия платформы Fargate, на которой выполняются задачи в наборе задач. Версия платформы указывается только для задач, выполняемых на Fargate. Для получения дополнительной информации см. версии платформы Fargate в руководстве разработчика Amazon Elastic Container Service.

platformFamily -> (строка)

Операционная система, на которой выполняются ваши задачи в наборе. Семейство платформ указывается только для задач, использующих тип запуска Fargate.

Все задачи в наборе должны иметь одинаковое значение.

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

Настройка сети для набора задач.

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

Подсети VPC и группы безопасности, связанные с задачей.

Примечание

Все указанные подсети и группы безопасности должны принадлежать одному и тому же VPC.

subnets -> (список)

Идентификаторы подсетей, связанных с задачей или службой. Можно указать до 16 подсетей.

Примечание

Все указанные подсети должны принадлежать одному и тому же VPC.

(строка)

securityGroups -> (список)

Идентификаторы групп безопасности, связанных с задачей или службой. Если вы не указываете группу безопасности, используется стандартная группа безопасности для VPC. Можно указать до 5 групп безопасности.

Примечание

Все указанные группы безопасности должны принадлежать одному и тому же VPC.

(строка)

assignPublicIp -> (строка)

Получает ли эластический интерфейс сети задачи публичный IP-адрес.

Учтите следующее, когда вы задаёте это значение:

При использовании create-service или update-service значение по умолчанию - DISABLED.
Когда служба deploymentController находится в состоянии ECS, значение должно быть DISABLED.

loadBalancers -> (список)

Подробности о балансировщике нагрузки, используемом с набором задач.

(структура)

Конфигурация балансировщика нагрузки для использования с сервисом или набором задач.

При добавлении, обновлении или удалении конфигурации балансировщика нагрузки Amazon ECS запускает новую развертывание с обновлённой конфигурацией Elastic Load Balancing. Это приводит к регистрации и отмене регистрации задач с балансировщиками нагрузки.

Рекомендуется проверить это в тестовой среде перед обновлением конфигурации Elastic Load Balancing.

Для сервисов, использующих несколько целевых групп, требуется роль, связанная с сервисом. Дополнительную информацию см. в разделе «Использование ролей, связанных с сервисом» в Руководстве разработчика Amazon Elastic Container Service.

targetGroupArn -> (строка)

Полное имя ресурса Amazon (ARN) целевой группы или групп Elastic Load Balancing, связанных с сервисом или набором задач.

ARN целевой группы указывается только при использовании Application Load Balancer или Network Load Balancer.

Для сервисов, использующих ECS контроллер развертывания, можно указать одну или несколько целевых групп. Дополнительную информацию см. в разделе «Регистрация нескольких целевых групп с сервисом» в Руководстве разработчика Amazon Elastic Container Service.

Для сервисов, использующих CODE_DEPLOY контроллер развертывания, необходимо определить две целевые группы для балансировщика нагрузки. Дополнительную информацию см. в разделе «Развертывание «синий/зелёный» с CodeDeploy» в Руководстве разработчика Amazon Elastic Container Service.

Предупреждение

Если определение задачи вашего сервиса использует awsvpc режим сети, необходимо выбрать ip в качестве типа целевого объекта, а не instance. Сделайте это при создании целевых групп, поскольку задачи, использующие awsvpc режим сети, связаны с интерфейсом эластичной сети, а не с экземпляром Amazon EC2. Этот режим сети необходим для типа запуска Fargate.

loadBalancerName -> (строка)

Имя балансировщика нагрузки, который необходимо связать с сервисом Amazon ECS или набором задач.

Если вы используете Application Load Balancer или Network Load Balancer, параметр load balancer name следует опустить.

containerName -> (строка)

Имя контейнера (как оно отображается в определении контейнера) для связи с балансировщиком нагрузки.

Имя контейнера необходимо указать при настройке целевой группы для балансировщика нагрузки Amazon ECS.

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

Порт в контейнере для связи с балансировщиком нагрузки. Этот порт должен соответствовать containerPort в определении задачи, которое используют задачи в сервисе. Для задач, использующих тип запуска EC2, экземпляр контейнера, на котором они запускаются, должен разрешать входящий трафик на hostPort сопоставления портов.

serviceRegistries -> (список)

Подробности для регистров обнаружения сервисов, которые необходимо назначить этому набору задач. Дополнительную информацию см. в разделе Обнаружение сервиса.

(структура)

Подробности для регистра сервиса.

Каждый сервис может быть связан с одним регистром сервиса. Несколько регистров сервиса для каждого сервиса не поддерживаются.

При добавлении, обновлении или удалении конфигурации регистров сервиса Amazon ECS запускает новую развертывание. Новые задачи регистрируются и отменяют регистрацию с обновленной конфигурацией регистра сервиса.

registryArn -> (строка)

Имя ресурса Amazon (ARN) регистра сервиса. В настоящее время поддерживается регистр сервиса Cloud Map. Дополнительную информацию см. в разделе CreateService.

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

Значение порта, используемое, если служба обнаружения сервиса указала запись SRV. Это поле может быть использовано, если используются как awsvpc режим сети, так и записи SRV.

containerName -> (строка)

Значение имени контейнера для использования в вашей службе обнаружения сервиса. Оно уже указано в определении задачи. Если определение задачи, которое указывает ваша задача сервиса, использует bridge или host режим сети, необходимо указать сочетание containerName и containerPort из определения задачи. Если определение задачи, которое указывает ваша задача сервиса, использует awsvpc режим сети и используется запись SRV DNS, необходимо указать сочетание containerName и containerPort или значение port. Однако оба значения указать нельзя.

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

Значение порта для использования в вашей службе обнаружения сервиса. Оно уже указано в определении задачи. Если определение задачи, которое указывает ваша задача сервиса, использует bridge или host режим сети, необходимо указать сочетание containerName и containerPort из определения задачи. Если определение задачи, которое указывает ваша задача сервиса, использует awsvpc режим сети и используется запись SRV DNS, необходимо указать сочетание containerName и containerPort или значение port. Однако оба значения указать нельзя.

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

Плавающая процентная доля от желаемого числа задач, которые необходимо разместить и поддерживать в наборе задач.

value -> (двойное)

Значение, указанное в процентах от общего числа desiredCount сервиса, для масштабирования набора задач. Допустимые значения — числа от 0 до 100.

unit -> (строка)

Единица измерения для значения масштаба.

stabilityStatus -> (строка)

Статус стабильности. Он указывает, достиг ли набор задач стабильного состояния. Если выполнены следующие условия, набор задач находится в STEADY_STATE состоянии:

Количество задач runningCount равно computedDesiredCount.
pendingCount находится в состоянии 0.
Нет задач, выполняющихся на экземплярах контейнеров в состоянии DRAINING.
Все задачи сообщают о нормальном состоянии от балансировщиков нагрузки, обнаружения сервиса и проверок состояния контейнера.

Если какие-либо из этих условий не выполнены, статус стабильности возвращает STABILIZING.

stabilityStatusAt -> (отметка времени)

Отметка времени Unix для времени, когда был получен статус стабильности набора задач.

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 -> (строка)

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

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

Параметры временного хранилища Fargate для набора задач.

kmsKeyId -> (строка)

Укажите идентификатор ключа Key Management Service для шифрования временного хранилища для развертывания.