Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

update-task-set

Описание

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

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

Синтаксис

  update-task-set
--cluster <value>
--service <value>
--task-set <value>
--scale <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) кластера, в котором размещена служба, содержащая набор задач.

--service (строка)

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

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

Короткое имя или полное Amazon Resource Name (ARN) набора задач, который необходимо обновить.

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

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

value -> (двойное значение)

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

unit -> (строка)

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

Сокращенный синтаксис:

value=double,unit=string

Синтаксис JSON:

{
  "value": double,
  "unit": "PERCENT"
}

--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
  • текст
  • таблица
  • 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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

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

Следующий update-task-set пример обновляет набор задач для корректировки масштабирования.

aws ecs update-task-set \
    --cluster MyCluster \
    --service MyService \
    --task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \
    --scale value=50,unit=PERCENT

Вывод:

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

Вывод

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 Elastic Container Service (Amazon ECS) в разделе Типы запуска Amazon ECS.

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

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

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

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

platformVersion -> (строка)

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

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 Resource Name (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, параметр имени балансировщика следует опустить.

containerName -> (строка)

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

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

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

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

serviceRegistries -> (список)

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

(структура)

Подробная информация о реестре сервисов.

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

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

registryArn -> (строка)

Amazon Resource Name (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 для шифрования временного хранилища для развертывания.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API