describe-container-instances
Описание
Описывает один или несколько контейнерных экземпляров. Возвращает метаданные о каждом запрошенном контейнерном экземпляре.
См. также: Документацию API AWS
Синтаксис
describe-container-instances
[--cluster <value>]
--container-instances <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 (строка)
--container-instances (список)
Список из не более чем 100 идентификаторов контейнерных экземпляров или полных записей Amazon Resource Name (ARN).
(строка)
Синтаксис:
"string" "string" ...
--include (список)
Указывает, хотите ли вы увидеть теги ресурсов для контейнерного экземпляра. Если TAGS указан, теги включаются в ответ. Если CONTAINER_INSTANCE_HEALTH указан, состояние здоровья контейнерного экземпляра включается в ответ. Если этот параметр опущен, теги и состояние здоровья контейнерного экземпляра не включаются в ответ.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
TAGS
CONTAINER_INSTANCE_HEALTH
--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 (строка)
Включить/отключить цветной вывод.
- вкл
- выкл
- авто
--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.
Для описания контейнерного экземпляра
В следующем describe-container-instances примере извлекаются данные для контейнерного экземпляра в update кластере, используя UUID контейнерного экземпляра в качестве идентификатора.
aws ecs describe-container-instances \
--cluster update \
--container-instances a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
Вывод:
{
"failures": [],
"containerInstances": [
{
"status": "ACTIVE",
"registeredResources": [
{
"integerValue": 2048,
"longValue": 0,
"type": "INTEGER",
"name": "CPU",
"doubleValue": 0.0
},
{
"integerValue": 3955,
"longValue": 0,
"type": "INTEGER",
"name": "MEMORY",
"doubleValue": 0.0
},
{
"name": "PORTS",
"longValue": 0,
"doubleValue": 0.0,
"stringSetValue": [
"22",
"2376",
"2375",
"51678"
],
"type": "STRINGSET",
"integerValue": 0
}
],
"ec2InstanceId": "i-A1B2C3D4",
"agentConnected": true,
"containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"pendingTasksCount": 0,
"remainingResources": [
{
"integerValue": 2048,
"longValue": 0,
"type": "INTEGER",
"name": "CPU",
"doubleValue": 0.0
},
{
"integerValue": 3955,
"longValue": 0,
"type": "INTEGER",
"name": "MEMORY",
"doubleValue": 0.0
},
{
"name": "PORTS",
"longValue": 0,
"doubleValue": 0.0,
"stringSetValue": [
"22",
"2376",
"2375",
"51678"
],
"type": "STRINGSET",
"integerValue": 0
}
],
"runningTasksCount": 0,
"versionInfo": {
"agentVersion": "1.0.0",
"agentHash": "4023248",
"dockerVersion": "DockerVersion: 1.5.0"
}
}
]
}
Для получения дополнительной информации см. Amazon ECS Container Instances в руководстве разработчика Amazon ECS.
Вывод
containerInstances -> (список)
Список экземпляров контейнеров.
(структура)
Экземпляр Amazon EC2 или внешний экземпляр, на котором запущен агент Amazon ECS и который зарегистрирован в кластере.
containerInstanceArn -> (строка)
ec2InstanceId -> (строка)
capacityProviderName -> (строка)
version -> (целое число)
detail), чтобы убедиться, что версия в вашем потоке событий актуальна.versionInfo -> (структура)
Сведения о версии агента Amazon ECS для контейнеров и демона Docker, работающих на экземпляре контейнера.
agentVersion -> (строка)
agentHash -> (строка)
dockerVersion -> (строка)
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. Если регистрация завершится неудачно, экземпляр перейдет в состояние REGISTRATION_FAILED. Вы можете описать экземпляр контейнера и увидеть причину неудачи в параметре statusReason. После завершения работы экземпляра контейнера экземпляр перейдет в состояние DEREGISTERING, пока сетевой интерфейс trunk не будет устранён. Затем экземпляр перейдет в состояние 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 -> (строка)
targetId -> (строка)
registeredAt -> (временная метка)
attachments -> (список)
Ресурсы, прикрепленные к экземпляру контейнера, например, сетевой интерфейс.
(структура)
Объект, представляющий прикрепление экземпляра контейнера или задачи.
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 -> (строка)
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 -> (метка времени)
lastStatusChange -> (метка времени)
failures -> (список)
Любые ошибки, связанные с вызовом.
(структура)
Неудачный ресурс. Список распространенных причин см. в разделе «Причины ошибок API» в руководстве разработчика Amazon Elastic Container Service.
arn -> (строка)
reason -> (строка)
detail -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.