Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

обновление-агента-контейнера

Описание

Обновляет агент Amazon ECS для контейнеров на указанном экземпляре контейнера. Обновление агента Amazon ECS для контейнеров не прерывает запущенные задачи или сервисы на экземпляре контейнера. Процесс обновления агента отличается в зависимости от того, был ли ваш экземпляр контейнера запущен с оптимизированной для Amazon ECS AMI или другой операционной системой.

Примечание

API UpdateContainerAgent не поддерживается для экземпляров контейнеров, использующих оптимизированную для Amazon ECS Amazon Linux 2 (arm64) AMI. Чтобы обновить агент контейнера, можно обновить пакет ecs-init. Это обновит агент. Дополнительную информацию см. в руководстве по обновлению агента Amazon ECS для контейнеров в руководстве разработчика Amazon Elastic Container Service.

Примечание

Обновления агента с помощью операции API UpdateContainerAgent не применяются к экземплярам контейнеров Windows. Рекомендуется запускать новые экземпляры контейнеров для обновления версии агента в ваших кластерах Windows.

API UpdateContainerAgent требует оптимизированной для Amazon ECS AMI или Amazon Linux AMI с установленным и работающим сервисом ecs-init. Для получения помощи по обновлению агента Amazon ECS для контейнеров в других операционных системах см. раздел Ручное обновление агента Amazon ECS для контейнеров в руководстве разработчика Amazon Elastic Container Service.

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

Синтаксис

  update-container-agent
[--cluster <value>]
--container-instance <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) кластера, на котором работает ваш экземпляр контейнера. Если вы не укажете кластер, будет использован кластер по умолчанию.

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

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

--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.

Чтобы обновить агент контейнера на экземпляре контейнера Amazon ECS

Следующий пример update-container-agent обновляет агент контейнера на указанном экземпляре контейнера в кластере по умолчанию.

aws ecs update-container-agent --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Вывод:

{
    "containerInstance": {
        "status": "ACTIVE",
...
        "agentUpdateStatus": "PENDING",
        "versionInfo": {
            "agentVersion": "1.0.0",
            "agentHash": "4023248",
            "dockerVersion": "DockerVersion: 1.5.0"
        }
    }
}

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

Вывод

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

Экземпляр контейнера, для которого был обновлён контейнерный агент.

containerInstanceArn -> (строка)

Amazon Resource Name (ARN) экземпляра контейнера. Дополнительную информацию о формате ARN см. в разделе Amazon Resource Name (ARN) в Руководстве разработчика Amazon ECS.

ec2InstanceId -> (строка)

Идентификатор экземпляра контейнера. Для экземпляров Amazon EC2 это идентификатор экземпляра Amazon EC2. Для внешних экземпляров это идентификатор управляемого экземпляра Amazon Web Services Systems Manager.

capacityProviderName -> (строка)

Провайдер ресурсов, связанный с экземпляром контейнера.

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

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

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

Информация о версии контейнерного агента Amazon ECS и демона Docker, работающего на экземпляре контейнера.

agentVersion -> (строка)

Номер версии контейнерного агента Amazon ECS.

agentHash -> (строка)

Хеш Git-коммита для сборки контейнерного агента Amazon ECS на репозитории GitHub amazon-ecs-agent.

dockerVersion -> (строка)

Версия Docker, работающая на экземпляре контейнера.

remainingResources -> (список)

Для типов ресурсов CPU и памяти этот параметр описывает оставшиеся CPU и память, которые ещё не были выделены задачам и поэтому доступны для новых задач. Для типов ресурсов портов этот параметр описывает порты, которые были зарезервированы контейнерным агентом Amazon ECS (во время регистрации экземпляра) и любые контейнеры задач, которые зарезервировали сопоставления портов на хосте (с режимом сети host или bridge). Любой порт, который здесь не указан, доступен для новых задач.

(структура)

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

name -> (строка)

Имя ресурса, например, CPU, MEMORY, PORTS, PORTS_UDP или пользовательский ресурс.

type -> (строка)

Тип ресурса. Допустимые значения: INTEGER, DOUBLE, LONG или STRINGSET.

doubleValue -> (двойное число)

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

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

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

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

Когда тип integerValue задан, значение ресурса должно быть целым числом.

stringSetValue -> (список)

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

(строка)

registeredResources -> (список)

Для типов ресурсов CPU и памяти этот параметр описывает количество каждого ресурса, которое было доступно на экземпляре контейнера, когда контейнерный агент зарегистрировал его в Amazon ECS. Это значение представляет собой общее количество CPU и памяти, которое можно выделить на этом экземпляре контейнера задачам. Для типов ресурсов портов этот параметр описывает порты, которые были зарезервированы контейнерным агентом Amazon ECS при регистрации экземпляра контейнера в Amazon ECS.

(структура)

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

name -> (строка)

Имя ресурса, например, CPU, MEMORY, PORTS, PORTS_UDP или пользовательский ресурс.

type -> (строка)

Тип ресурса. Допустимые значения: INTEGER, DOUBLE, LONG или STRINGSET.

doubleValue -> (двойное число)

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

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

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

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

Когда тип integerValue задан, значение ресурса должно быть целым числом.

stringSetValue -> (список)

Когда тип stringSetValue задан, значение ресурса должно быть строкового типа.

(строка)

status -> (строка)

Статус экземпляра контейнера. Допустимые значения: REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING или DRAINING.

Если ваш аккаунт включил настройку аккаунта awsvpcTrunking, то любой новый зарегистрированный экземпляр контейнера перейдёт в статус REGISTERING во время выделения trunk elastic network interface для экземпляра. Если регистрация завершится неудачно, экземпляр перейдёт в статус REGISTRATION_FAILED. Вы можете описать экземпляр контейнера и увидеть причину ошибки в параметре statusReason. После завершения работы экземпляра контейнера, экземпляр перейдёт в статус DEREGISTERING во время снятия с выделения trunk elastic network interface. Затем экземпляр перейдёт в статус INACTIVE.

Статус ACTIVE указывает, что экземпляр контейнера может принимать задачи. Статус DRAINING указывает, что новые задачи не размещаются на экземпляре контейнера, и любые задачи сервиса, выполняемые на экземпляре контейнера, удаляются, если это возможно. Дополнительную информацию см. в разделе Вывод экземпляра контейнера в состояние ожидания в Руководстве разработчика Amazon Elastic Container Service.

statusReason -> (строка)

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

agentConnected -> (булево значение)

Этот параметр возвращает значение true, если агент подключён к Amazon ECS. Экземпляр с агентом, который может быть неисправен или остановлен, возвращает значение false. Только экземпляры, подключённые к агенту, могут принимать запросы на размещение задач.

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

Количество задач на экземпляре контейнера, имеющих желаемый статус (desiredStatus) RUNNING.

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

Количество задач на экземпляре контейнера, находящихся в статусе PENDING.

agentUpdateStatus -> (строка)

Статус последнего обновления агента. Если запрос на обновление никогда не поступал, это значение равно NULL.

attributes -> (список)

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

(структура)

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

name -> (строка)

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

value -> (строка)

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

targetType -> (строка)

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

targetId -> (строка)

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

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

Маркер Unix-времени для момента регистрации экземпляра контейнера.

attachments -> (список)

Ресурсы, прикреплённые к экземпляру контейнера, такие как сетевой интерфейс elastic network interface.

(структура)

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

id -> (строка)

Уникальный идентификатор прикрепления.

type -> (строка)

Тип прикрепления, например, ElasticNetworkInterface, Service Connect и AmazonElasticBlockStorage.

status -> (строка)

Статус прикрепления. Допустимые значения: PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED и FAILED.

details -> (список)

Детали прикрепления.

Для elastic network interfaces это включает идентификатор сетевого интерфейса, MAC-адрес, идентификатор подсети и частный IPv4-адрес.

Для сервисов Service Connect это включает portName, clientAliases, discoveryName и ingressPortOverride.

Для Elastic Block Storage это включает roleArn, deleteOnTermination, volumeName, volumeId и statusReason (только когда прикрепление не удаётся создать или подключить).

(структура)

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

name -> (строка)

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

value -> (строка)

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

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 действует как описание в рамках категории тега (ключ).

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

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

overallStatus -> (строка)

Общее состояние здоровья экземпляра контейнера. Это агрегированное состояние всех проверок состояния здоровья экземпляра контейнера.

details -> (список)

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

(структура)

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

type -> (строка)

Тип состояния здоровья экземпляра контейнера, который был проверен.

status -> (строка)

Состояние здоровья экземпляра контейнера.

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

Маркер времени Unix, когда состояние здоровья экземпляра контейнера было в последний раз обновлено.

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

Маркер времени Unix, когда состояние здоровья экземпляра контейнера в последний раз изменилось.

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

Spec-Zone.ru

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