Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

get-instance-snapshots

Описание

Возвращает все снимки экземпляров для учетной записи пользователя.

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

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

Синтаксис

  get-instance-snapshots
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

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

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

Маркер для указания, с какой позиции начать постраничную загрузку. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Чтобы получить информацию обо всех снимках ваших экземпляров

Следующий пример get-instance-snapshots отображает сведения обо всех снимках экземпляров в настроенном AWS-регионе.

aws lightsail get-instance-snapshots

Вывод:

{
    "instanceSnapshots": [
        {
            "name": "MEAN-1-1571421498",
            "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/a20e6ebe-b0ee-4ae4-a750-3EXAMPLEcb0c",
            "supportCode": "6EXAMPLE3362/ami-0EXAMPLEe33cabfa1",
            "createdAt": 1571421527.755,
            "location": {
                "availabilityZone": "all",
                "regionName": "us-west-2"
            },
            "resourceType": "InstanceSnapshot",
            "tags": [
                {
                    "key": "no_delete"
                }
            ],
            "state": "available",
            "fromAttachedDisks": [],
            "fromInstanceName": "MEAN-1",
            "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/1761aa0a-6038-4f25-8b94-2EXAMPLE19fd",
            "fromBlueprintId": "wordpress",
            "fromBundleId": "micro_3_0",
            "isFromAutoSnapshot": false,
            "sizeInGb": 40
        },
        {
            "name": "MEAN-1-1571419854",
            "arn": "arn:aws:lightsail:us-west-2:111122223333:InstanceSnapshot/ac54700c-48a8-40fd-b065-2EXAMPLEac8f",
            "supportCode": "6EXAMPLE3362/ami-0EXAMPLE67a73020d",
            "createdAt": 1571419891.927,
            "location": {
                "availabilityZone": "all",
                "regionName": "us-west-2"
            },
            "resourceType": "InstanceSnapshot",
            "tags": [],
            "state": "available",
            "fromAttachedDisks": [],
            "fromInstanceName": "MEAN-1",
            "fromInstanceArn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-8EXAMPLEbada",
            "fromBlueprintId": "mean",
            "fromBundleId": "medium_3_0",
            "isFromAutoSnapshot": false,
            "sizeInGb": 80
        }
    ]
}

Вывод

instanceSnapshots -> (список)

Массив пар ключ-значение, содержащих информацию о результатах запроса get instance snapshots.

(структура)

Описание моментального снимка экземпляра.

name -> (строка)

Имя снимка.

arn -> (строка)

Amazon Resource Name (ARN) снимка (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

supportCode -> (строка)

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

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

Временная метка создания снимка (1479907467.024).

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

Имя региона и зона доступности, где вы создали снимок.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимый).

regionName -> (строка)

Название региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса (обычно InstanceSnapshot).

tags -> (список)

Ключи тегов и необязательные значения для ресурса. Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

(структура)

Описание ключа тега и необязательного значения, назначенного ресурсу Amazon Lightsail.

Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают максимум 128 букв, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: Значения тегов принимают максимум 256 букв, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @

state -> (строка)

Состояние снимка.

progress -> (строка)

Прогресс снимка.

Примечание

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

fromAttachedDisks -> (список)

Массив объектов диска, содержащих информацию обо всех дисках блочного хранилища.

(структура)

Описание диска блочного хранилища.

name -> (строка)

Уникальное имя диска.

arn -> (строка)

Amazon Resource Name (ARN) диска.

supportCode -> (строка)

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

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

Дата создания диска.

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

AWS регион и зона доступности, где расположен диск.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимый).

regionName -> (строка)

Название региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса Lightsail (Disk).

tags -> (список)

Ключи тегов и необязательные значения для ресурса. Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

(структура)

Описание ключа тега и необязательного значения, назначенного ресурсу Amazon Lightsail.

Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают максимум 128 букв, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: Значения тегов принимают максимум 256 букв, цифр, пробелов в UTF-8 или следующие символы: + - = . _ : / @

addOns -> (список)

Массив объектов, представляющих плагины, включенные в диск.

(структура)

Описание плагина, включенного в ресурс Amazon Lightsail.

name -> (строка)

Название плагина.

status -> (строка)

Статус плагина.

snapshotTimeOfDay -> (строка)

Ежедневное время создания автоматического снимка.

Показанное время в формате HH:00 и в формате Coordinated Universal Time (UTC).

Снимок автоматически создается между указанным временем и через 45 минут после него.

nextSnapshotTimeOfDay -> (строка)

Следующее ежедневное время создания автоматического снимка.

Показанное время в формате HH:00 и в формате Coordinated Universal Time (UTC).

Снимок автоматически создается между указанным временем и через 45 минут после него.

threshold -> (строка)

Пороговое значение срабатывания действия.

Предупреждение

Этот плагин применяется только к ресурсам Lightsail для исследований.

duration -> (строка)

Количество времени простоя в минутах, после которого ваш виртуальный компьютер автоматически остановится.

Предупреждение

Этот плагин применяется только к ресурсам Lightsail для исследований.

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

Размер диска в ГБ.

isSystemDisk -> (булево значение)

Булево значение, указывающее, является ли этот диск системным диском (на котором загружена операционная система).

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

Ввод/вывод операций в секунду (IOPS) диска.

path -> (строка)

Путь к диску.

state -> (строка)

Описание состояния диска.

attachedTo -> (строка)

Ресурсы, к которым подключен диск.

isAttached -> (булево значение)

Булево значение, указывающее, подключен ли диск.

attachmentState -> (строка)

(Отменено) Состояние подключения диска.

Примечание

В версиях до 14 ноября 2017 года этот параметр возвращал attached для системных дисков в ответе API. Теперь он отменен, но все еще включен в ответ. Используйте isAttached вместо него.

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

(Отменено) Количество используемых ГБ диска.

Примечание

В версиях до 14 ноября 2017 года этот параметр не был включен в ответ API. Теперь он отменен.

autoMountStatus -> (строка)

Статус автоматического подключения диска хранилища к виртуальному компьютеру.

Предупреждение

Этот параметр применим только к ресурсам Lightsail для исследований.

fromInstanceName -> (строка)

Экземпляр, с которого был создан снимок.

fromInstanceArn -> (строка)

Amazon Resource Name (ARN) экземпляра, с которого был создан снимок (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

fromBlueprintId -> (строка)

Идентификатор шаблона, с помощью которого вы создали снимок (amazon_linux_2023). Шаблон — это образ виртуального сервера (или экземпляра), используемый для быстрого создания экземпляров.

fromBundleId -> (строка)

Идентификатор пакета, с помощью которого вы создали снимок (micro_x_x).

isFromAutoSnapshot -> (булево значение)

Булево значение, указывающее, был ли снимок создан из автоматического снимка.

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

Размер SSD в ГБ.

nextPageToken -> (строка)

Токен для перехода к следующей странице результатов вашего запроса.

Токен следующей страницы не возвращается, если больше результатов отобразить не нужно.

Чтобы получить следующую страницу результатов, выполните еще один GetInstanceSnapshots запрос и укажите токен следующей страницы с помощью параметра pageToken.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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