Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

describe-tasks

Описание

Описывает указанную задачу или задачи.

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

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

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

Синтаксис

  describe-tasks
[--cluster <value>]
--tasks <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) кластера, в котором размещена задача или задачи для описания. Если вы не указываете кластер, используется по умолчанию. Этот параметр обязателен. Если вы не указываете значение, используется кластер по умолчанию.

--tasks (список)

Список из до 100 идентификаторов задач или полных записей 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
  • таблица
  • 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 (логическое значение)

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

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

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

Примеры

Примечание

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

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

Пример 1: Описание одной задачи

Следующий describe-tasks пример извлекает подробности о задаче в кластере. Вы можете указать задачу, используя либо идентификатор, либо полное ARN задачи. В этом примере используется полное ARN задачи.

aws ecs describe-tasks \
    --cluster MyCluster \
    --tasks arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58EXAMPLE

Вывод:

{
    "tasks": [
        {
            "attachments": [],
            "attributes": [
                {
                    "name": "ecs.cpu-architecture",
                    "value": "x86_64"
                }
            ],
            "availabilityZone": "us-east-1b",
            "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
            "connectivity": "CONNECTED",
            "connectivityAt": "2021-08-11T12:21:26.681000-04:00",
            "containerInstanceArn": "arn:aws:ecs:us-east-1:123456789012:container-instance/test/025c7e2c5e054a6790a29fc1fEXAMPLE",
            "containers": [
                {
                    "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/4d590253bb114126b7afa7b58eea9221/a992d1cc-ea46-474a-b6e8-24688EXAMPLE",
                    "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58EXAMPLE",
                    "name": "simple-app",
                    "image": "httpd:2.4",
                    "runtimeId": "91251eed27db90006ad67b1a08187290869f216557717dd5c39b37c94EXAMPLE",
                    "lastStatus": "RUNNING",
                    "networkBindings": [
                        {
                            "bindIP": "0.0.0.0",
                            "containerPort": 80,
                            "hostPort": 80,
                            "protocol": "tcp"
                        }
                    ],
                    "networkInterfaces": [],
                    "healthStatus": "UNKNOWN",
                    "cpu": "10",
                    "memory": "300"
                }
            ],
            "cpu": "10",
            "createdAt": "2021-08-11T12:21:26.681000-04:00",
            "desiredStatus": "RUNNING",
            "enableExecuteCommand": false,
            "group": "service:testupdate",
            "healthStatus": "UNKNOWN",
            "lastStatus": "RUNNING",
            "launchType": "EC2",
            "memory": "300",
            "overrides": {
                "containerOverrides": [
                    {
                        "name": "simple-app"
                    }
                ],
                "inferenceAcceleratorOverrides": []
            },
            "pullStartedAt": "2021-08-11T12:21:28.234000-04:00",
            "pullStoppedAt": "2021-08-11T12:21:33.793000-04:00",
            "startedAt": "2021-08-11T12:21:34.945000-04:00",
            "startedBy": "ecs-svc/968695068243EXAMPLE",
            "tags": [],
            "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58eea9221",
            "taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/console-sample-app-static2:1",
            "version": 2
        }
    ],
    "failures": []
}

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

Пример 2: Описание нескольких задач

Следующий describe-tasks пример извлекает подробности о нескольких задачах в кластере. Вы можете указать задачу, используя либо идентификатор, либо полное ARN задачи. В этом примере используются полные идентификаторы задач.

aws ecs describe-tasks \
    --cluster MyCluster \
    --tasks "74de0355a10a4f979ac495c14EXAMPLE" "d789e94343414c25b9f6bd59eEXAMPLE"

Вывод:

{
    "tasks": [
        {
            "attachments": [
                {
                    "id": "d9e7735a-16aa-4128-bc7a-b2d51EXAMPLE",
                    "type": "ElasticNetworkInterface",
                    "status": "ATTACHED",
                    "details": [
                        {
                            "name": "subnetId",
                            "value": "subnet-0d0eab1bb3EXAMPLE"
                        },
                        {
                            "name": "networkInterfaceId",
                            "value": "eni-0fa40520aeEXAMPLE"
                        },
                        {
                            "name": "macAddress",
                            "value": "0e:89:76:28:07:b3"
                        },
                        {
                            "name": "privateDnsName",
                            "value": "ip-10-0-1-184.ec2.internal"
                        },
                        {
                            "name": "privateIPv4Address",
                            "value": "10.0.1.184"
                        }
                    ]
                }
            ],
            "attributes": [
                {
                    "name": "ecs.cpu-architecture",
                    "value": "x86_64"
                }
            ],
            "availabilityZone": "us-east-1b",
            "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
            "connectivity": "CONNECTED",
            "connectivityAt": "2021-12-20T12:13:37.875000-05:00",
            "containers": [
                {
                    "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/74de0355a10a4f979ac495c14EXAMPLE/aad3ba00-83b3-4dac-84d4-11f8cEXAMPLE",
                    "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/74de0355a10a4f979ac495c14EXAMPLE",
                    "name": "web",
                    "image": "nginx",
                    "runtimeId": "74de0355a10a4f979ac495c14EXAMPLE-265927825",
                    "lastStatus": "RUNNING",
                    "networkBindings": [],
                    "networkInterfaces": [
                        {
                            "attachmentId": "d9e7735a-16aa-4128-bc7a-b2d51EXAMPLE",
                            "privateIpv4Address": "10.0.1.184"
                        }
                    ],
                    "healthStatus": "UNKNOWN",
                    "cpu": "99",
                    "memory": "100"
                }
            ],
            "cpu": "256",
            "createdAt": "2021-12-20T12:13:20.226000-05:00",
            "desiredStatus": "RUNNING",
            "enableExecuteCommand": false,
            "group": "service:tdsevicetag",
            "healthStatus": "UNKNOWN",
            "lastStatus": "RUNNING",
            "launchType": "FARGATE",
            "memory": "512",
            "overrides": {
                "containerOverrides": [
                    {
                        "name": "web"
                    }
                ],
                "inferenceAcceleratorOverrides": []
            },
            "platformVersion": "1.4.0",
            "platformFamily": "Linux",
            "pullStartedAt": "2021-12-20T12:13:42.665000-05:00",
            "pullStoppedAt": "2021-12-20T12:13:46.543000-05:00",
            "startedAt": "2021-12-20T12:13:48.086000-05:00",
            "startedBy": "ecs-svc/988401040018EXAMPLE",
            "tags": [],
            "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/74de0355a10a4f979ac495c14EXAMPLE",
            "taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/webserver:2",
            "version": 3,
            "ephemeralStorage": {
            "sizeInGiB": 20
            }
        },
        {
            "attachments": [
                {
                    "id": "214eb5a9-45cd-4bf8-87bc-57fefEXAMPLE",
                    "type": "ElasticNetworkInterface",
                    "status": "ATTACHED",
                    "details": [
                        {
                            "name": "subnetId",
                            "value": "subnet-0d0eab1bb3EXAMPLE"
                        },
                        {
                            "name": "networkInterfaceId",
                            "value": "eni-064c7766daEXAMPLE"
                        },
                        {
                            "name": "macAddress",
                            "value": "0e:76:83:01:17:a9"
                        },
                        {
                            "name": "privateDnsName",
                            "value": "ip-10-0-1-41.ec2.internal"
                        },
                        {
                            "name": "privateIPv4Address",
                            "value": "10.0.1.41"
                        }
                    ]
                }
            ],
            "attributes": [
                {
                    "name": "ecs.cpu-architecture",
                    "value": "x86_64"
                }
            ],
            "availabilityZone": "us-east-1b",
            "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
            "connectivity": "CONNECTED",
            "connectivityAt": "2021-12-20T12:13:35.243000-05:00",
            "containers": [
                {
                    "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE/9afef792-609b-43a5-bb6a-3efdbEXAMPLE",
                    "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE",
                    "name": "web",
                    "image": "nginx",
                    "runtimeId": "d789e94343414c25b9f6bd59eEXAMPLE-265927825",
                    "lastStatus": "RUNNING",
                    "networkBindings": [],
                    "networkInterfaces": [
                        {
                            "attachmentId": "214eb5a9-45cd-4bf8-87bc-57fefEXAMPLE",
                            "privateIpv4Address": "10.0.1.41"
                        }
                    ],
                    "healthStatus": "UNKNOWN",
                    "cpu": "99",
                    "memory": "100"
                }
            ],
            "cpu": "256",
            "createdAt": "2021-12-20T12:13:20.226000-05:00",
            "desiredStatus": "RUNNING",
            "enableExecuteCommand": false,
            "group": "service:tdsevicetag",
            "healthStatus": "UNKNOWN",
            "lastStatus": "RUNNING",
            "launchType": "FARGATE",
            "memory": "512",
            "overrides": {
                "containerOverrides": [
                    {
                        "name": "web"
                    }
                ],
                "inferenceAcceleratorOverrides": []
            },
            "platformVersion": "1.4.0",
            "platformFamily": "Linux",
            "pullStartedAt": "2021-12-20T12:13:44.611000-05:00",
            "pullStoppedAt": "2021-12-20T12:13:48.251000-05:00",
            "startedAt": "2021-12-20T12:13:49.326000-05:00",
            "startedBy": "ecs-svc/988401040018EXAMPLE",
            "tags": [],
            "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE",
            "taskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/webserver:2",
            "version": 3,
            "ephemeralStorage": {
                "sizeInGiB": 20
            }
        }
    ],
    "failures": []
}

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

Вывод

задачи -> (список)

Список задач.

(структура)

Подробности о задаче в кластере.

attachments -> (список)

Адаптер Elastic Network, связанный с задачей, если задача использует режим сети awsvpc.

(структура)

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

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

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

attributes -> (список)

Атрибуты задачи

(структура)

Атрибут — это пара «имя-значение», которая ассоциирована с объектом Amazon ECS. Используйте атрибуты для расширения модели данных Amazon ECS, добавив пользовательские метаданные к вашим ресурсам. Дополнительные сведения см. в разделе Атрибуты в руководстве разработчика Amazon Elastic Container Service .

name -> (строка)

Имя атрибута. Имя name должно содержать от 1 до 128 символов. Имя может содержать буквы (строчные и прописные), цифры, дефисы (-), подчеркивания (_), слеши (/), обратные слеши (), или точки (.).

value -> (строка)

Значение атрибута. Значение value должно содержать от 1 до 128 символов. Оно может содержать буквы (строчные и прописные), цифры, дефисы (-), подчеркивания (_), точки (.), знаки «@», слеши (/), обратные слеши (), двоеточия (:) или пробелы. Значение не может начинаться или заканчиваться пробелом.

targetType -> (строка)

Тип целевого объекта для прикрепления атрибута. Этот параметр необходим, если вы используете сокращенный идентификатор ресурса вместо полного ARN.

targetId -> (строка)

Идентификатор целевого объекта. Вы можете указать сокращенный идентификатор ресурса или полный Amazon Resource Name (ARN).

availabilityZone -> (строка)

Зона доступности для задачи.

capacityProviderName -> (строка)

Провайдер емкости, связанный с задачей.

clusterArn -> (строка)

ARN кластера, в котором размещена задача.

connectivity -> (строка)

Статус подключения задачи.

connectivityAt -> (временная метка)

Временная метка Unix для времени, когда задача последний раз перешла в состояние CONNECTED .

containerInstanceArn -> (строка)

ARN контейнерных экземпляров, на которых размещена задача.

containers -> (список)

Контейнеры, связанные с задачей.

(структура)

Контейнер Docker, который является частью задачи.

containerArn -> (строка)

Amazon Resource Name (ARN) контейнера.

taskArn -> (строка)

ARN задачи.

name -> (строка)

Имя контейнера.

image -> (строка)

Изображение, используемое для контейнера.

imageDigest -> (строка)

Хеш-код образа контейнера.

runtimeId -> (строка)

Идентификатор контейнера Docker.

lastStatus -> (строка)

Последнее известное состояние контейнера.

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

Код возврата, возвращаемый контейнером.

reason -> (строка)

Короткий (максимум 1024 символа) читаемый человеком текст, предоставляющий дополнительные сведения о работающем или остановленном контейнере.

networkBindings -> (список)

Связки сетей, связанные с контейнером.

(структура)

Подробности о связях сетей между контейнером и его контейнерным экземпляром-хостом. После того, как задача переходит в состояние RUNNING , ручные и автоматические назначения портов хоста и контейнера отображаются в разделе networkBindings ответов API DescribeTasks.

bindIP -> (строка)

IP-адрес, к которому привязан контейнер на экземпляре контейнера-хоста.

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

Номер порта в контейнере, используемый в связке сети.

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

Номер порта на хосте, используемый в связке сети.

protocol -> (строка)

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

containerPortRange -> (строка)

Диапазон номеров портов в контейнере, связанных с динамически назначаемым диапазоном портов хоста.

Следующие правила применяются при указании containerPortRange :

  • Вы должны использовать либо режим сети bridge , либо режим сети awsvpc .
  • Этот параметр доступен для типов запуска EC2 и Fargate.
  • Этот параметр доступен для операционных систем Linux и Windows.
  • Контейнерный экземпляр должен иметь по крайней мере версию 1.67.0 агента контейнера и по крайней мере версию 1.67.0-1 пакета ecs-init
  • Вы можете указать максимальное количество 100 диапазонов портов на контейнер.
  • Вы не указываете hostPortRange . Значение hostPortRange устанавливается следующим образом:
    • Для контейнеров в задаче с режимом сети awsvpc , hostPortRange устанавливается равным значению containerPortRange . Это стратегия статического сопоставления.
    • Для контейнеров в задаче с режимом сети bridge , агент Amazon ECS находит открытые порты хоста из стандартного диапазона временных портов и передает их docker для привязки к портам контейнера.
  • Допустимые значения containerPortRange находятся в диапазоне от 1 до 65535.
  • Порт может быть включен только в одном сопоставлении портов на контейнер.
  • Вы не можете указывать перекрывающиеся диапазоны портов.
  • Первый порт в диапазоне должен быть меньше последнего порта в диапазоне.
  • Docker рекомендует отключить docker-proxy в файле конфигурации демона Docker, если у вас большое количество портов. Дополнительные сведения см. в проблеме #11185 на сайте GitHub. Сведения о том, как отключить docker-proxy в файле конфигурации демона Docker, см. в разделе Демон Docker в руководстве разработчика Amazon ECS.

Вы можете вызвать ` DescribeTasks https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html`__ для просмотра hostPortRange , которые являются портами хоста, привязанными к портам контейнера.

hostPortRange -> (строка)

Диапазон номеров портов на хосте, используемый в связке сети. Он назначается docker и передается агентом Amazon ECS.

networkInterfaces -> (список)

Сетевые интерфейсы, связанные с контейнером.

(структура)

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

attachmentId -> (строка)

Идентификатор прикрепления сетевого интерфейса.

privateIpv4Address -> (строка)

Частный IPv4-адрес сетевого интерфейса.

ipv6Address -> (строка)

Частный IPv6-адрес сетевого интерфейса.

healthStatus -> (строка)

Состояние работоспособности контейнера. Если для этого контейнера в его определении задачи не настроены проверки работоспособности, то он сообщает о состоянии работоспособности как UNKNOWN .

managedAgents -> (список)

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

(структура)

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

lastStartedAt -> (временная метка)

Временная метка Unix для времени последнего запуска управляемого агента.

name -> (строка)

Имя управляемого агента. При включении функции выполнения команд имя управляемого агента равно ExecuteCommandAgent .

reason -> (строка)

Причина, по которой управляемый агент находится в текущем состоянии.

lastStatus -> (строка)

Последнее известное состояние управляемого агента.

cpu -> (строка)

Количество блоков ЦП, установленных для контейнера. Значение равно 0 , если значение не было указано в определении контейнера при регистрации определения задачи.

memory -> (строка)

Жесткий лимит памяти (в МБ), установленный для контейнера.

memoryReservation -> (строка)

Мягкий лимит памяти (в МБ), установленный для контейнера.

gpuIds -> (список)

Идентификаторы каждого графического процессора, назначенного контейнеру.

(строка)

cpu -> (строка)

Количество блоков ЦП, используемых задачей, выраженное в определении задачи. Оно может быть выражено как целое число, используя блоки ЦП (например, 1024 ). Оно также может быть выражено как строка, используя vCPU (например, 1 vCPU или 1 vcpu ). Значения строк преобразуются в целое число, указывающее блоки ЦП, при регистрации определения задачи.

Если вы используете тип запуска EC2 или внешний тип запуска, этот параметр необязателен. Поддерживаемые значения находятся в диапазоне от 128 блоков ЦП (0.125 vCPU) до 196608 блоков ЦП (192 vCPU). Если вы не указываете значение, параметр игнорируется.

Этот параметр обязателен для Fargate. Сведения о допустимых значениях см. в разделе Размер задачи в руководстве разработчика Amazon Elastic Container Service.

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

Временная метка Unix для времени создания задачи. Более точно, это время, когда задача перешла в состояние PENDING .

desiredStatus -> (строка)

Желаемое состояние задачи. Дополнительные сведения см. в разделе Жизненный цикл задачи.

enableExecuteCommand -> (логическое значение)

Определяет, включена ли функция выполнения команд для этой задачи. Если true , функция выполнения команд включена для всех контейнеров в задаче.

executionStoppedAt -> (временная метка)

Временная метка Unix для времени остановки выполнения задачи.

group -> (строка)

Имя группы задач, связанной с задачей.

healthStatus -> (строка)

Статус работоспособности задачи. Определяется состоянием основных контейнеров в задаче. Если все основные контейнеры в задаче сообщают о статусе HEALTHY, то статус задачи также сообщается как HEALTHY. Если любой из основных контейнеров в задаче сообщает о статусе UNHEALTHY или UNKNOWN, то статус задачи также сообщается как UNHEALTHY или UNKNOWN.

Примечание

Агент контейнера Amazon ECS не отслеживает и не сообщает о проверках работоспособности Docker, встроенных в образ контейнера и не указанных в определении контейнера. Например, это относится к проверкам, указанным в родительском образе или в файле Dockerfile образа. Параметры проверки работоспособности, указанные в определении контейнера, переопределяют любые проверки работоспособности Docker, найденные в образе контейнера.

inferenceAccelerators -> (список)

Ускоритель Elastic Inference, связанный с задачей.

(структура)

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

deviceName -> (строка)

Имя устройства ускорителя Elastic Inference. deviceName также должен быть указан в определении контейнера как ResourceRequirement.

deviceType -> (строка)

Тип ускорителя Elastic Inference для использования.

lastStatus -> (строка)

Последний известный статус задачи. Дополнительную информацию см. в разделе Жизненный цикл задачи.

launchType -> (строка)

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

memory -> (строка)

Объем памяти (в МБ), используемой задачей, выраженный в определении задачи. Он может быть выражен как целое число с использованием МБ (например, 1024). Если он выражен как строка с использованием ГБ (например, 1GB или 1 GB), он преобразуется в целое число, указывающее МБ, при регистрации определения задачи.

Если используется тип запуска EC2, это поле необязательно.

Если используется тип запуска Fargate, это поле обязательно. Вы должны использовать одно из следующих значений. Выбранное значение определяет диапазон допустимых значений параметра cpu.

  • 512 (0,5 ГБ), 1024 (1 ГБ), 2048 (2 ГБ) - Доступные cpu значения: 256 (.25 vCPU)
  • 1024 (1 ГБ), 2048 (2 ГБ), 3072 (3 ГБ), 4096 (4 ГБ) - Доступные cpu значения: 512 (.5 vCPU)
  • 2048 (2 ГБ), 3072 (3 ГБ), 4096 (4 ГБ), 5120 (5 ГБ), 6144 (6 ГБ), 7168 (7 ГБ), 8192 (8 ГБ) - Доступные cpu значения: 1024 (1 vCPU)
  • Между 4096 (4 ГБ) и 16384 (16 ГБ) с шагом 1024 (1 ГБ) - Доступные cpu значения: 2048 (2 vCPU)
  • Между 8192 (8 ГБ) и 30720 (30 ГБ) с шагом 1024 (1 ГБ) - Доступные cpu значения: 4096 (4 vCPU)
  • Между 16 ГБ и 60 ГБ с шагом 4 ГБ - Доступные cpu значения: 8192 (8 vCPU). Этот вариант требует платформу Linux 1.4.0 или более позднюю.
  • Между 32 ГБ и 120 ГБ с шагом 8 ГБ - Доступные cpu значения: 16384 (16 vCPU). Этот вариант требует платформу Linux 1.4.0 или более позднюю.

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

Один или несколько переопределений контейнера.

containerOverrides -> (список)

Один или несколько переопределений контейнера, отправленных в задачу.

(структура)

Переопределения, отправленные контейнеру. Можно передать пустое переопределение контейнера. Пример пустого переопределения контейнера — {"containerOverrides": [ ] }. Если указано ненулевое переопределение контейнера, необходимо включить параметр name.

Для хранения конфиденциальных данных можно использовать Secrets Manager или Amazon Web Services Systems Manager Parameter Store. Дополнительную информацию см. в руководстве по Amazon ECS: Получение секретов через переменные окружения.

name -> (строка)

Имя контейнера, получившего переопределение. Этот параметр обязателен, если указано любое переопределение.

command -> (список)

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

(строка)

environment -> (список)

Переменные среды, отправляемые контейнеру. Можно добавить новые переменные среды, которые добавляются в контейнер при запуске, или можно переопределить существующие переменные среды из образа Docker или определения задачи. Также необходимо указать имя контейнера.

(структура)

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

name -> (строка)

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

value -> (строка)

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

environmentFiles -> (список)

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

(структура)

Список файлов, содержащих переменные среды, передаваемые контейнеру. Можно указать до десяти файлов переменных среды. Файл должен иметь расширение .env. Каждая строка в файле переменных среды должна содержать переменную среды в формате VARIABLE=VALUE. Строки, начинающиеся с #, обрабатываются как комментарии и игнорируются.

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

Файлы переменных среды являются объектами в Amazon S3, и все соображения безопасности Amazon S3 применимы.

Для типа запуска Fargate необходимо использовать следующие платформы:

  • Платформа Linux версии 1.4.0 или более поздней.
  • Платформа Windows версии 1.0.0 или более поздней.

Следует учитывать следующее при использовании типа запуска Fargate:

  • Файл обрабатывается как родной файл Docker env-file.
  • Обработка экранирования оболочки не поддерживается.
  • Точка входа контейнера интерпретирует значения VARIABLE.

value -> (строка)

Amazon Resource Name (ARN) объекта Amazon S3, содержащего файл переменной среды.

type -> (строка)

Тип используемого файла. Файлы переменных среды — это объекты в Amazon S3. Поддерживается только значение s3.

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

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

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

Жесткий лимит (в МБ) памяти, предоставляемой контейнеру вместо значения по умолчанию из определения задачи. Если контейнер пытается превысить заданную здесь память, контейнер завершается.

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

Мягкий лимит (в МБ) памяти, резервируемой для контейнера вместо значения по умолчанию из определения задачи. Также необходимо указать имя контейнера.

resourceRequirements -> (список)

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

(структура)

Тип и количество ресурса для назначения контейнеру. Поддерживаемые типы ресурсов — GPU и ускорители Elastic Inference. Дополнительную информацию см. в руководстве Amazon Elastic Container Service: Работа с GPU в Amazon ECS или Работа с Amazon Elastic Inference в Amazon ECS.

value -> (строка)

Значение для указанного типа ресурса.

Когда тип — GPU, значение равно количеству физических GPUs, зарезервированных агентом контейнера Amazon ECS для контейнера. Количество GPU, зарезервированных для всех контейнеров в задаче, не может превышать количество доступных GPU на экземпляре контейнера, на котором запущена задача.

Когда тип — InferenceAccelerator, значение value соответствует значению deviceName для InferenceAccelerator, указанного в определении задачи.

type -> (строка)

Тип ресурса, назначаемого контейнеру.

cpu -> (строка)

Переопределение процессора для задачи.

inferenceAcceleratorOverrides -> (список)

Переопределение ускорителя Elastic Inference для задачи.

(структура)

Подробности о переопределении ускорителя Elastic Inference для задачи. Этот параметр используется для переопределения ускорителя Elastic Inference, указанного в определении задачи. Дополнительную информацию см. в разделе Работа с Amazon Elastic Inference в Amazon ECS в руководстве разработчика Amazon Elastic Container Service.

deviceName -> (строка)

Имя устройства ускорителя Elastic Inference, которое нужно переопределить для задачи. Этот параметр должен соответствовать значению deviceName, указанному в определении задачи.

deviceType -> (строка)

Тип ускорителя Elastic Inference для использования.

executionRoleArn -> (строка)

Amazon Resource Name (ARN) переопределения роли выполнения задачи для задачи. Дополнительную информацию см. в разделе IAM-роль выполнения задач Amazon ECS в руководстве разработчика Amazon Elastic Container Service.

memory -> (строка)

Переопределение памяти для задачи.

taskRoleArn -> (строка)

Amazon Resource Name (ARN) роли, которую контейнеры в этой задаче могут принять. Все контейнеры в этой задаче получают разрешения, указанные в этой роли. Дополнительную информацию см. в разделе IAM-роль для задач в руководстве разработчика Amazon Elastic Container Service.

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

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

Примечание

Этот параметр поддерживается только для задач, размещенных в Fargate, которые используют следующие версии платформы:

  • Платформа Linux версии 1.4.0 или более поздней.
  • Платформа Windows версии 1.0.0 или более поздней.

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

Общий объем временного хранилища в ГБ, настраиваемый для задачи. Минимальное поддерживаемое значение — 21 ГБ, максимальное — 200 ГБ.

platformVersion -> (строка)

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

platformFamily -> (строка)

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

Все задачи, выполняемые в рамках этой службы, должны использовать то же значение platformFamily, что и служба (например, LINUX.).

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

Маркер Unix для времени начала извлечения изображения контейнера.

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

Маркер Unix для времени завершения извлечения изображения контейнера.

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

Маркер Unix для времени начала задачи. Более точно, это время перехода задачи из состояния PENDING в состояние RUNNING.

startedBy -> (строка)

Тег, указанный при запуске задачи. Если задачу запустила служба Amazon ECS, параметр startedBy содержит идентификатор развертывания этой службы.

stopCode -> (строка)

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

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

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

Маркер Unix для времени остановки задачи. Более точно, это время перехода задачи из состояния RUNNING в состояние STOPPED.

stoppedReason -> (строка)

Причина остановки задачи.

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

Маркер Unix для времени остановки задачи. Более точно, это время перехода задачи из состояния RUNNING в состояние STOPPING.

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

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

taskArn -> (строка)

Amazon Resource Name (ARN) задачи.

taskDefinitionArn -> (строка)

ARN определения задачи, которое создает задачу.

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

Счетчик версии задачи. Каждый раз, когда задача претерпевает изменение, которое запускает событие CloudWatch, счетчик версии увеличивается. Если вы дублируете состояние задачи Amazon ECS с помощью CloudWatch Events, вы можете сравнить версию задачи, сообщенную действиями API Amazon ECS, с версией, сообщенной в CloudWatch Events для задачи (внутри объекта detail), чтобы убедиться, что версия в вашем потоке событий актуальна.

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

Настройки временного хранилища для задачи.

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

Общий объем временного хранилища в ГБ для задачи. Минимальное поддерживаемое значение - 21 ГБ, а максимальное - 200 ГБ.

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

Настройки временного хранилища Fargate для задачи.

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

Общий объем временного хранилища в ГБ для задачи. Минимальное поддерживаемое значение - 20 ГБ, а максимальное - 200 ГБ.

kmsKeyId -> (строка)

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

failures -> (список)

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

(структура)

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

arn -> (строка)

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

reason -> (строка)

Причина сбоя.

detail -> (строка)

Подробности сбоя.

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

Spec-Zone.ru

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