describe-store-image-tasks
Описание
Описывает ход выполнения задач хранения AMI. Можно описать задачи хранения для указанных AMI. Если вы не укажете AMI, будет получен постраничный список задач хранения за последние 31 день.
Для каждой задачи AMI в ответе указывается, является ли задача InProgress , Completed или Failed. Для задач InProgress ответ отображает оценочный прогресс в процентах.
Задачи перечислены в обратном хронологическом порядке. В настоящее время можно просмотреть только задачи за последние 31 день.
Для использования этого API необходимо иметь необходимые разрешения. Дополнительную информацию см. в разделе Разрешения для хранения и восстановления AMI с использованием Amazon S3 в руководстве пользователя Amazon EC2.
Дополнительную информацию см. в разделе Хранение и восстановление AMI с помощью Amazon S3 в руководстве пользователя Amazon EC2.
См. также: Документация API AWS
describe-store-image-tasks — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе аргумент --query должен извлекать данные из результатов следующих выражений запроса: StoreImageTaskResults
Синтаксис
describe-store-image-tasks
[--image-ids <value>]
[--dry-run | --no-dry-run]
[--filters <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]
Параметры
--image-ids (список)
Идентификаторы AMI, для которых необходимо отобразить ход выполнения. В запросе можно указать до 20 идентификаторов AMI.
(строка)
Синтаксис:
"string" "string" ...
--dry-run | --no-dry-run (логическое значение)
DryRunOperation. В противном случае — UnauthorizedOperation.--filters (список)
Фильтры.
-
task-state— Возвращает задачи в определённом состоянии (InProgress|Completed|Failed) -
bucket— Возвращает информацию о задаче для задач, нацеленных на определённый бакет. В качестве значения фильтра укажите имя бакета.
Примечание
Когда вы указываете параметрImageIds, любые фильтры, которые вы укажете, игнорируются. Чтобы использовать фильтры, необходимо удалить параметр ImageIds.(структура)
Пара имя-значение фильтра, используемая для получения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определённым критериям, таким как теги, атрибуты или идентификаторы.
Если вы указываете несколько фильтров, они соединяются операцией AND, и запрос возвращает только результаты, соответствующие всем указанным фильтрам.
Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в руководстве пользователя Amazon EC2.
Имя -> (строка)
Значения -> (список)
Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, они соединяются операцией OR, и запрос возвращает все результаты, соответствующие любому из указанных значений.
(строка)
Сокращённый синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания точки начала постраничного вывода. Это NextToken из ранее обрезанного ответа.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы для получения данных от AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству обращений к AWS-сервису с меньшим количеством элементов в каждом вызове. Это может помочь предотвратить таймауты при обращениях к AWS-сервису.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода необходимо указать значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую за пределами AWS CLI.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.
--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
- таблица
- 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, соответствующего двоичному блоку, 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 в разделе «Использование кавычек со строками».
Для описания хода выполнения задачи хранения AMI
Следующий пример describe-store-image-tasks описывает ход выполнения задачи хранения AMI.
aws ec2 describe-store-image-tasks
Вывод:
{
"StoreImageTaskResults": [
{
"AmiId": "ami-1234567890abcdef0",
"Bucket": "my-ami-bucket",
"ProgressPercentage": 17,
"S3objectKey": "ami-1234567890abcdef0.bin",
"StoreTaskState": "InProgress",
"StoreTaskFailureReason": null,
"TaskStartTime": "2022-01-01T01:01:01.001Z"
}
]
}
Дополнительную информацию о хранении и восстановлении AMI с помощью S3 см. в разделе «Хранение и восстановление AMI с помощью S3 <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html>» в руководстве пользователя Amazon EC2.
Вывод
StoreImageTaskResults -> (список)
Информация о задачах хранения AMI.
(структура)
Информация о задаче хранения AMI, включая ход выполнения задачи.
AmiId -> (строка)
TaskStartTime -> (метка времени)
Бакет -> (строка)
S3objectKey -> (строка)
ProgressPercentage -> (целое число)
StoreTaskState -> (строка)
InProgress, Completed или Failed).StoreTaskFailureReason -> (строка)
null.NextToken -> (строка)
null, когда больше элементов возвращать не нужно.
© Copyright 2025, Amazon Web Services. Created using Sphinx.