Spec-Zone.ru › AWS CLI v2

[ aws . ecr ]

describe-images

Описание

Возвращает метаданные об изображениях в репозитории.

Примечание

Начиная с версии Docker 1.9, Docker-клиент сжимает слои изображений перед их отправкой в реестр Docker V2. Вывод команды docker images показывает размер изображения без сжатия, поэтому он может вернуть больший размер изображения, чем размер изображений, возвращаемый DescribeImages.

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

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

Синтаксис

  describe-images
[--registry-id <value>]
--repository-name <value>
[--image-ids <value>]
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--registry-id (строка)

Идентификатор учетной записи Amazon Web Services, связанный с реестром, который содержит репозиторий, в котором необходимо описать изображения. Если вы не указываете реестр, предполагается использование стандартного реестра.

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

Репозиторий, содержащий изображения, которые нужно описать.

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

Список идентификаторов изображений для запрошенного репозитория.

(структура)

Объект с идентификационной информацией для изображения в репозитории Amazon ECR.

imageDigest -> (строка)

sha256 хеш-код манифеста изображения.

imageTag -> (строка)

Тег, используемый для изображения.

Краткая форма записи:

imageDigest=string,imageTag=string ...

Синтаксис JSON:

[
  {
    "imageDigest": "string",
    "imageTag": "string"
  }
  ...
]

--filter (структура)

Ключ и значение фильтра, используемые для фильтрации результатов DescribeImages.

tagStatus -> (строка)

Статус тега, используемый для фильтрации результатов DescribeImages. Вы можете фильтровать результаты, основываясь на том, являются ли они TAGGED или UNTAGGED.

Краткая форма записи:

tagStatus=string

Синтаксис JSON:

{
  "tagStatus": "TAGGED"|"UNTAGGED"|"ANY"
}

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

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

Токен для указания места начала постраничной обработки. Это NextToken из ранее усечённого ответа.

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

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

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

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

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

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

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. При отсутствии значения или значении input выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включает отладовую запись в журнал.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды указанным URL.

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

Используйте определенный профиль из вашего файла с данными учетных данных.

--region (строка)

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

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для описания изображения в репозитории

Следующий describe-images пример отображает подробности об изображении в репозитории cluster-autoscaler с тегом v1.13.6.

aws ecr describe-images \
    --repository-name cluster-autoscaler \
    --image-ids imageTag=v1.13.6

Вывод:

{
    "imageDetails": [
        {
            "registryId": "012345678910",
            "repositoryName": "cluster-autoscaler",
            "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5",
            "imageTags": [
                "v1.13.6"
            ],
            "imageSizeInBytes": 48318255,
            "imagePushedAt": 1565128275.0
        }
    ]
}

Вывод

imageDetails -> (список)

Список объектов ImageDetail, содержащих данные об изображении.

(структура)

Объект, описывающий изображение, возвращённое операцией DescribeImages.

registryId -> (строка)

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

repositoryName -> (строка)

Имя хранилища, к которому принадлежит это изображение.

imageDigest -> (строка)

sha256 дайджест образа манифеста.

imageTags -> (список)

Список тегов, связанных с этим изображением.

(строка)

imageSizeInBytes -> (длинное целое число)

Размер изображения в байтах в хранилище.

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

Примечание

Начиная с версии Docker 1.9, клиент Docker сжимает слои изображений перед их отправкой в реестр Docker версии 2. Вывод команды docker images показывает нескомпрессированный размер изображения. Поэтому Docker может возвращать больший размер изображения, чем размер, возвращаемый DescribeImages.

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

Дата и время, выраженные в стандартном формате даты JavaScript, когда текущее изображение было отправлено в хранилище.

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

Текущее состояние сканирования.

status -> (строка)

Текущее состояние сканирования изображения.

description -> (строка)

Описание состояния сканирования изображения.

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

Резюме последнего завершённого сканирования изображения.

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

Время последнего завершённого сканирования изображения.

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

Время последнего обновления данных о уязвимостях.

findingSeverityCounts -> (карта)

Счётчики уязвимостей изображения, отсортированные по степени критичности.

ключ -> (строка)

значение -> (целое число)

imageManifestMediaType -> (строка)

Тип носителя манифеста изображения.

artifactMediaType -> (строка)

Тип носителя артефакта изображения.

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

Дата и время, выраженные в стандартном формате даты JavaScript, когда Amazon ECR записал последнее извлечение изображения.

Примечание

Amazon ECR обновляет метку времени последнего извлечения изображения как минимум один раз в 24 часа. Например, если вы извлекаете изображение один раз в день, то метка времени lastRecordedPullTime укажет точное время последнего извлечения изображения. Однако, если вы извлекаете изображение один раз в час, поскольку Amazon ECR обновляет метку времени lastRecordedPullTime как минимум один раз в 24 часа, результат может не отражать точное время последнего извлечения изображения.

nextToken -> (строка)

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

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

Spec-Zone.ru

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