Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-instance-image-metadata

Описание

Описывает AMI, который использовался для запуска экземпляра, даже если AMI устарел, дерегистрирован, стал частным (больше не общедоступен или не доступен вашей учётной записи) или запрещён.

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

Если вы укажете недействительный идентификатор экземпляра, экземпляр, которого не существует, или экземпляр, которым вы не владеете, возвращается ошибка (InvalidInstanceID.NotFound).

Недавно завершённые экземпляры могут появиться в результатах. Этот интервал обычно составляет менее одного часа.

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

Примечание

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

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

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

Синтаксис

  describe-instance-image-metadata
[--filters <value>]
[--instance-ids <value>]
[--dry-run | --no-dry-run]
[--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]

Параметры

--filters (список)

Фильтры.

  • availability-zone — имя зоны доступности (например, us-west-2a) или локальной зоны (например, us-west-2-lax-1b) экземпляра.
  • instance-id — идентификатор экземпляра.
  • image-allowed — логическое значение, указывающее, соответствует ли AMI критериям, указанным для разрешённых AMI.
  • instance-state-name — состояние экземпляра (pending | running | shutting-down | terminated | stopping | stopped).
  • instance-type — тип экземпляра (например, t3.micro).
  • launch-time — время запуска экземпляра в формате ISO 8601 в часовом поясе UTC (ГГГГ-ММ-ДДЧЧ:ММ:СС.ССЗ), например, 2023-09-29T11:04:43.305Z. Вы можете использовать подстановку (*), например, 2023-09-29T*, которая соответствует целому дню.
  • owner-alias — псевдоним владельца (amazon | aws-marketplace | aws-backup-vault). Действительные псевдонимы определены в поддерживаемом Amazon списке. Это не псевдоним учетной записи Amazon Web Services, который можно установить с помощью консоли IAM. Рекомендуется использовать параметр запроса Owner вместо этого фильтра.
  • owner-id — идентификатор учетной записи Amazon Web Services владельца. Рекомендуется использовать параметр запроса Owner вместо этого фильтра.
  • tag:<key> — сочетание ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA, укажите tag:Owner для имени фильтра и TeamA для значения фильтра.
  • tag-key — ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с определённым ключом, независимо от значения тега.
  • zone-id — идентификатор зоны доступности (например, usw2-az2) или локальной зоны (например, usw2-lax1-az1) экземпляра.

(структура)

Пара имя-значение фильтра, используемая для получения более специфического списка результатов операции describe. Фильтры могут использоваться для соответствия набору ресурсов по определённым критериям, таким как теги, атрибуты или идентификаторы.

Если вы указываете несколько фильтров, фильтры объединяются с помощью AND, и запрос возвращает только результаты, которые соответствуют всем указанным фильтрам.

Дополнительную информацию см. в разделе «Список и фильтрация с помощью командной строки и API» в Руководстве пользователя Amazon EC2.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения объединяются с помощью OR, и запрос возвращает все результаты, которые соответствуют любому из указанных значений.

(строка)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--instance-ids (список)

Идентификаторы экземпляров.

Если вы не указываете идентификатор экземпляра или фильтры, вывод содержит информацию обо всех экземплярах.

(строка)

Синтаксис:

"string" "string" ...

--dry-run | --no-dry-run (логическое значение)

Проверяет, есть ли у вас необходимые разрешения для действия, не выполняя фактический запрос, и возвращает ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке — DryRunOperation. В противном случае — UnauthorizedOperation.

--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 (boolean)

Включить отладку логов.

--endpoint-url (string)

Переопределить стандартный URL команды на указанный.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла аутентификации.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Пример 1: Описание метаданных AMI для всех экземпляров

Следующий describe-instance-image-metadata пример описывает метаданные AMI для всех экземпляров в вашей учётной записи AWS в указанном регионе.

aws ec2 describe-instance-image-metadata \
    --region us-east-1

Вывод:

{
    "InstanceImageMetadata": [
        {
            "InstanceId": "i-1234567890EXAMPLE",
            "InstanceType": "t2.micro",
            "LaunchTime": "2024-08-28T11:25:45+00:00",
            "AvailabilityZone": "us-east-1a",
            "State": {
                "Code": 16,
                "Name": "running"
            },
            "OwnerId": "123412341234",
            "Tags": [
                {
                    "Key": "MyTagName",
                    "Value": "my-tag-value"
                }
            ],
            "ImageMetadata": {
                "ImageId": "ami-0b752bf1df193a6c4",
                "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64",
                "OwnerId": "137112412989",
                "State": "available",
                "ImageOwnerAlias": "amazon",
                "CreationDate": "2023-01-25T17:20:40Z",
                "DeprecationTime": "2025-01-25T17:20:40Z",
                "IsPublic": true
            }
        }
    ],
    "NextToken": "...EXAMPLEwIAABAA2JHaFxLnEXAMPLE..."
}

Дополнительную информацию см. в разделе Amazon Machine Images в Amazon EC2 в Руководстве пользователя Amazon EC2.

Пример 2: Описание метаданных AMI для указанных экземпляров

Следующий describe-instance-image-metadata пример описывает метаданные AMI для указанных экземпляров.

aws ec2 describe-instance-image-metadata \
    --region us-east-1 \
    --instance-ids i-1234567890EXAMPLE i-0987654321EXAMPLE

Вывод:

{
    "InstanceImageMetadata": [
        {
            "InstanceId": "i-1234567890EXAMPLE",
            "InstanceType": "t2.micro",
            "LaunchTime": "2024-08-28T11:25:45+00:00",
            "AvailabilityZone": "us-east-1a",
            "State": {
                "Code": 16,
                "Name": "running"
            },
            "OwnerId": "123412341234",
            "Tags": [
                {
                    "Key": "MyTagName",
                    "Value": "my-tag-value"
                }
            ],
            "ImageMetadata": {
                "ImageId": "ami-0b752bf1df193a6c4",
                "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64",
                "OwnerId": "137112412989",
                "State": "available",
                "ImageOwnerAlias": "amazon",
                "CreationDate": "2023-01-25T17:20:40Z",
                "DeprecationTime": "2025-01-25T17:20:40Z",
                "IsPublic": true
            }
        },
        {
            "InstanceId": "i-0987654321EXAMPLE",
            "InstanceType": "t2.micro",
            "LaunchTime": "2024-08-28T11:25:45+00:00",
            "AvailabilityZone": "us-east-1a",
            "State": {
                "Code": 16,
                "Name": "running"
            },
            "OwnerId": "123412341234",
            "Tags": [
                {
                    "Key": "MyTagName",
                    "Value": "my-tag-value"
                }
            ],
            "ImageMetadata": {
                "ImageId": "ami-0b752bf1df193a6c4",
                "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64",
                "OwnerId": "137112412989",
                "State": "available",
                "ImageOwnerAlias": "amazon",
                "CreationDate": "2023-01-25T17:20:40Z",
                "DeprecationTime": "2025-01-25T17:20:40Z",
                "IsPublic": true
            }
        }
    ]
}

Дополнительную информацию см. в разделе Amazon Machine Images в Amazon EC2 в Руководстве пользователя Amazon EC2.

Пример 3: Описание метаданных AMI для экземпляров на основе фильтров

Следующий describe-instance-image-metadata пример описывает метаданные AMI для t2.nano и t2.micro экземпляров в us-east-1a зоне доступности.

aws ec2 describe-instance-image-metadata \
    --region us-east-1 \
    --filters Name=availability-zone,Values=us-east-1a Name=instance-type,Values=t2.nano,t2.micro

Вывод:

{
    "InstanceImageMetadata": [
        {
            "InstanceId": "i-1234567890EXAMPLE",
            "InstanceType": "t2.micro",
            "LaunchTime": "2024-08-28T11:25:45+00:00",
            "AvailabilityZone": "us-east-1a",
            "State": {
                "Code": 16,
                "Name": "running"
            },
            "OwnerId": "123412341234",
            "Tags": [
                {
                    "Key": "MyTagName",
                    "Value": "my-tag-value"
                }
            ],
            "ImageMetadata": {
                "ImageId": "ami-0b752bf1df193a6c4",
                "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64",
                "OwnerId": "137112412989",
                "State": "available",
                "ImageOwnerAlias": "amazon",
                "CreationDate": "2023-01-25T17:20:40Z",
                "DeprecationTime": "2025-01-25T17:20:40Z",
                "IsPublic": true
            }
        },
        {
            "InstanceId": "i-0987654321EXAMPLE",
            "InstanceType": "t2.micro",
            "LaunchTime": "2024-08-28T11:25:45+00:00",
            "AvailabilityZone": "us-east-1a",
            "State": {
                "Code": 16,
                "Name": "running"
            },
            "OwnerId": "123412341234",
            "Tags": [
                {
                    "Key": "MyTagName",
                    "Value": "my-tag-value"
                }
            ],
            "ImageMetadata": {
                "ImageId": "ami-0b752bf1df193a6c4",
                "Name": "al2023-ami-2023.5.20240819.0-kernel-6.1-x86_64",
                "OwnerId": "137112412989",
                "State": "available",
                "ImageOwnerAlias": "amazon",
                "CreationDate": "2023-01-25T17:20:40Z",
                "DeprecationTime": "2025-01-25T17:20:40Z",
                "IsPublic": true
            }
        }
    ],
    "NextToken": "...EXAMPLEV7ixRYHwIAABAA2JHaFxLnDAzpatfEXAMPLE..."
}

Дополнительную информацию см. в разделе Amazon Machine Images в Amazon EC2 в Руководстве пользователя Amazon EC2.

Вывод

InstanceImageMetadata -> (список)

Информация об экземпляре и AMI, используемом для запуска экземпляра.

(структура)

Информация об экземпляре и AMI, используемом для запуска экземпляра.

InstanceId -> (строка)

ID экземпляра.

InstanceType -> (строка)

Тип экземпляра.

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

Время запуска экземпляра.

AvailabilityZone -> (строка)

Зона доступности или локальная зона экземпляра.

ZoneId -> (строка)

ID зоны доступности или локальной зоны экземпляра.

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

Текущее состояние экземпляра.

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

Состояние экземпляра как 16-битное беззнаковое целое число.

Высокий байт содержит все биты от 28 до (216)-1, что соответствует десятичным значениям от 256 до 65 535. Эти числовые значения используются во внутренних целях и должны игнорироваться.

Низкий байт содержит все биты от 20 до (28)-1, что соответствует десятичным значениям от 0 до 255.

Допустимые значения instance-state-code находятся в диапазоне низкого байта и они следующие:

  • 0 : pending
  • 16 : running
  • 32 : shutting-down
  • 48 : terminated
  • 64 : stopping
  • 80 : stopped

Вы можете проигнорировать высокое значение байта, обнулив все биты выше 28 или 256 в десятичной системе.

Name -> (строка)

Текущее состояние экземпляра.

OwnerId -> (строка)

ID учётной записи Amazon Web Services, которая владеет экземпляром.

Tags -> (список)

Любые метки, назначенные экземпляру.

(структура)

Описывает метку.

Key -> (строка)

Ключ метки.

Ограничения: ключи меток регистрозависимые и принимают не более 127 символов Юникода. Не должно начинаться с aws:.

Value -> (строка)

Значение метки.

Ограничения: значения меток регистрозависимые и принимают не более 256 символов Юникода.

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

Информация об AMI, используемом для запуска экземпляра.

ImageId -> (строка)

ID AMI.

Name -> (строка)

Название AMI.

OwnerId -> (строка)

ID учётной записи Amazon Web Services, которая владеет AMI.

State -> (строка)

Текущее состояние AMI. Если состояние равно available, AMI успешно зарегистрирован и может быть использован для запуска экземпляра.

ImageOwnerAlias -> (строка)

Псевдоним владельца AMI.

Допустимые значения: amazon | aws-backup-vault | aws-marketplace

CreationDate -> (строка)

Дата и время создания AMI.

DeprecationTime -> (строка)

Дата и время устаревания AMI в UTC в формате YYYY-MM-DDT*HH* :MM :SSZ.

ImageAllowed -> (boolean)

Если true, AMI соответствует критериям разрешённых AMI и может быть обнаружен и использован в учётной записи. Если false, AMI не может быть обнаружен или использован в учётной записи.

Дополнительную информацию см. в разделе Управление обнаружением и использованием AMI в Amazon EC2 с разрешёнными AMI в Руководстве пользователя Amazon EC2.

IsPublic -> (boolean)

Указывает, имеет ли AMI общедоступные права запуска. Значение true означает, что у этого AMI есть общедоступные права запуска, в то время как false означает, что он имеет только неявные (владелец AMI) или явные (общий с вашей учётной записью) права запуска.

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

Сущность, которая управляет экземпляром.

Managed -> (boolean)

Если true, ресурс управляется поставщиком услуг.

Principal -> (строка)

Если managed равно true, тогда возвращается субъект. Субъект — это поставщик услуг, который управляет ресурсом.

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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