Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

list-tasks

Описание

Возвращает список задач. Вы можете фильтровать результаты по кластеру, семейству определений задач, контейнерному экземпляру, типу запуска, принципалу IAM, который запустил задачу, или по желаемому статусу задачи.

Недавно остановленные задачи могут отображаться в возвращаемых результатах.

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

list-tasks является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе на запрос с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: taskArns

Синтаксис

  list-tasks
[--cluster <value>]
[--container-instance <value>]
[--family <value>]
[--started-by <value>]
[--service-name <value>]
[--desired-status <value>]
[--launch-type <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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) кластера для использования при фильтрации результатов ListTasks. Если вы не указываете кластер, используется по умолчанию.

--container-instance (строка)

Идентификатор контейнерного экземпляра или полный ARN контейнерного экземпляра для использования при фильтрации результатов ListTasks. Указание containerInstance ограничивает результаты задачами, которые относятся к этому контейнерному экземпляру.

--family (строка)

Имя семейства определений задач для использования при фильтрации результатов ListTasks. Указание family ограничивает результаты задачами, которые относятся к этому семейству.

--started-by (строка)

Значение startedBy для фильтрации результатов задач. Указание значения startedBy ограничивает результаты задачами, которые были запущены с этим значением.

При указании startedBy как фильтра, он должен быть единственным фильтром, который вы используете.

--service-name (строка)

Имя сервиса для использования при фильтрации результатов ListTasks. Указание serviceName ограничивает результаты задачами, которые относятся к этому сервису.

--desired-status (строка)

Желаемый статус задачи для использования при фильтрации результатов ListTasks. Указание статуса desiredStatus STOPPED ограничивает результаты задачами, для которых Amazon ECS установил желаемый статус STOPPED. Это может быть полезно для отладки задач, которые не запускаются должным образом, или завершились/погибли. По умолчанию фильтр статуса - RUNNING, который показывает задачи, для которых Amazon ECS установил желаемый статус RUNNING.

Примечание

Хотя вы можете фильтровать результаты по желаемому статусу PENDING, это не возвращает никаких результатов. Amazon ECS никогда не устанавливает желаемый статус задачи в это значение (только статус задачи lastStatus может иметь значение PENDING).

Возможные значения:

  • RUNNING
  • PENDING
  • STOPPED

--launch-type (строка)

Тип запуска для использования при фильтрации результатов ListTasks.

Возможные значения:

  • EC2
  • FARGATE
  • EXTERNAL

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

--starting-token (строка)

Токен для указания, где начать постраничный запрос. Это значение NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания AWS-сервисов.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.

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

Регион для использования. Переопределяет настройки config/env.

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (логическое значение)

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

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

Файл с сертификатами CA для использования при проверке сертификатов SSL. Переопределяет настройки config/env.

--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 (логическое значение)

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

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

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

Примеры

Примечание

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

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

Пример 1: Перечисление задач в кластере

Следующий list-tasks пример перечисляет все задачи в кластере.

aws ecs list-tasks --cluster default

Вывод:

{
    "taskArns": [
        "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
    ]
}

Пример 2: Перечисление задач на конкретном контейнерном экземпляре

Следующий list-tasks пример перечисляет задачи на контейнерном экземпляре, используя UUID контейнерного экземпляра в качестве фильтра.

aws ecs list-tasks --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

Вывод:

{
    "taskArns": [
        "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"
    ]
}

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

Вывод

taskArns -> (список)

Список записей ARN задач для запроса ListTasks.

(строка)

nextToken -> (строка)

Значение nextToken для включения в последующий запрос ListTasks. Когда результаты запроса ListTasks превышают maxResults, это значение можно использовать для получения следующей страницы результатов. Это значение null, когда больше результатов не возвращается.

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

Spec-Zone.ru

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