Spec-Zone.ru › AWS CLI v2

[ aws . ecr-public ]

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>]
[--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"
  }
  ...
]

--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. Если предоставлено значение null или значение 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
  • текст
  • таблица
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Пример 1: Описание изображений в репозитории общедоступного реестра

Следующий пример describe-images описывает изображения в репозитории с именем project-a/nginx-web-app в общедоступном реестре.

aws ecr-public describe-images \
    --repository-name project-a/nginx-web-app \
    --region us-east-1

Вывод:

{
    "imageDetails": [
        {
            "registryId": "123456789012",
            "repositoryName": "project-a/nginx-web-app",
            "imageDigest": "sha256:0d8c93e72e82fa070d49565c00af32abbe8ddfd7f75e39f4306771ae0628c7e8",
            "imageTags": [
                "temp1.0"
            ],
            "imageSizeInBytes": 123184716,
            "imagePushedAt": "2024-07-23T11:32:49-05:00",
            "imageManifestMediaType": "application/vnd.docker.distribution.manifest.v2+json",
            "artifactMediaType": "application/vnd.docker.container.image.v1+json"
        },
        {
            "registryId": "123456789012",
            "repositoryName": "project-a/nginx-web-app",
            "imageDigest": "sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2",
            "imageTags": [
                "temp2.0"
            ],
            "imageSizeInBytes": 121956548,
            "imagePushedAt": "2024-07-23T11:39:38-05:00",
            "imageManifestMediaType": "application/vnd.docker.distribution.manifest.v2+json",
            "artifactMediaType": "application/vnd.docker.container.image.v1+json"
        },
        {
            "registryId": "123456789012",
            "repositoryName": "project-a/nginx-web-app",
            "imageDigest": "sha256:f7a86a0760e2f8d7eff07e515fc87bf4bac45c35376c06f9a280f15ecad6d7e0",
            "imageTags": [
                "temp3.0",
                "latest"
            ],
            "imageSizeInBytes": 232108879,
            "imagePushedAt": "2024-07-22T00:54:34-05:00",
            "imageManifestMediaType": "application/vnd.docker.distribution.manifest.v2+json",
            "artifactMediaType": "application/vnd.docker.container.image.v1+json"
        }
    ]
}

Дополнительную информацию см. в разделе Описание изображения в общедоступном репозитории в Amazon ECR Public.

Пример 2: Описание изображений из репозитория по сортировке imageTags & imagePushedAt

Следующий пример describe-images описывает изображения в репозитории с именем project-a/nginx-web-app в общедоступном реестре.

aws ecr-public describe-images \
    --repository-name project-a/nginx-web-app \
    --query 'sort_by(imageDetails,& imagePushedAt)[*].imageTags[*]' \
    --output text

Вывод:

temp3.0 latest
temp1.0
temp2.0

Пример 3: Описание изображений из репозитория для получения последних 2 тегов изображений, опубликованных в репозитории

Следующий пример describe-images получает детали тегов изображений из репозитория с именем project-a/nginx-web-app в общедоступном реестре и запросы результата для отображения только первых двух записей.

aws ecr-public describe-images \
    --repository-name project-a/nginx-web-app  \
    --query 'sort_by(imageDetails,& imagePushedAt)[*].imageTags[*] | [0:2]' \
    --output text

Вывод:

temp3.0 latest
temp1.0

Вывод

imageDetails -> (список)

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

(структура)

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

registryId -> (строка)

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

repositoryName -> (строка)

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

imageDigest -> (строка)

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

imageTags -> (список)

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

(строка)

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

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

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

Примечание

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

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

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

imageManifestMediaType -> (строка)

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

artifactMediaType -> (строка)

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

nextToken -> (строка)

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

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

Spec-Zone.ru

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