describe-task-sets

Описание

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

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

Синтаксис

  describe-task-sets
--cluster <value>
--service <value>
[--task-sets <value>]
[--include <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-sets (список)

Идентификатор или полное Amazon Resource Name (ARN) набора задач для описания.

(строка)

Синтаксис:

"string" "string" ...

--include (список)

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

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  TAGS

--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 describe-task-sets \
    --cluster MyCluster \
    --service MyService \
    --task-sets arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789

Вывод:

{
    "taskSets": [
        {
            "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": 1557207715.195,
            "updatedAt": 1557207740.014,
            "launchType": "EC2",
            "networkConfiguration": {
                "awsvpcConfiguration": {
                    "subnets": [
                        "subnet-12344321"
                    ],
                    "securityGroups": [
                        "sg-1234431"
                    ],
                    "assignPublicIp": "DISABLED"
                }
            },
            "loadBalancers": [],
            "serviceRegistries": [],
            "scale": {
                "value": 0.0,
                "unit": "PERCENT"
            },
            "stabilityStatus": "STEADY_STATE",
            "stabilityStatusAt": 1557207740.014
        }
    ],
    "failures": []
}

Вывод

taskSets -> (список)

Список наборов задач, описанных.

(структура)

Информация о наборе задач Amazon ECS в развертывании CodeDeploy или EXTERNAL. Набор задач Amazon ECS включает такие детали, как желаемое количество задач, количество запущенных задач и служит ли набор задач производственным трафиком.

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.

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

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

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

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

platformVersion -> (строка)

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

failures -> (список)

Любые ошибки, связанные с вызовом.

(структура)

Неудачный ресурс. Список распространённых причин см. в разделе «Причины ошибок API» в руководстве разработчика Amazon Elastic Container Service.

arn -> (строка)

Amazon Resource Name (ARN) неудачного ресурса.

reason -> (строка)

Причина ошибки.

detail -> (строка)

Подробности ошибки.

END_OF_DOCUMENT_MARKER