describe-snapshots

Описание

Описывает указанные моментальные снимки EBS, доступные вам, или все моментальные снимки EBS, доступные вам.

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

Права на создание томов относятся к следующим категориям:

• публичный : Владелец моментального снимка предоставил права на создание томов для моментального снимка группе all. Все учетные записи Amazon Web Services имеют права на создание томов для этих моментальных снимков.
• явный : Владелец моментального снимка предоставил права на создание томов конкретной учетной записи Amazon Web Services.
• неявный : Учетная запись Amazon Web Services имеет неявные права на создание томов для всех моментальных снимков, которые она владеет.

Список возвращаемых моментальных снимков можно отфильтровать, указав идентификаторы моментальных снимков, владельцев моментальных снимков или учетные записи Amazon Web Services с правами на создание томов. Если не указаны никакие параметры, Amazon EC2 возвращает все моментальные снимки, для которых у вас есть права на создание томов.

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

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

Если вы укажете список восстанавливаемых пользователей, будут возвращены только моментальные снимки с правами на создание моментальных снимков для этих пользователей. Вы можете указать идентификаторы учетных записей Amazon Web Services (если вы владеете моментальными снимками), self для моментальных снимков, которые вы владеете или для которых у вас есть явные права, или all для публичных моментальных снимков.

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

Чтобы получить состояние быстрых восстановлений моментальных снимков для моментального снимка, используйте DescribeFastSnapshotRestores.

Дополнительную информацию о моментальных снимках EBS см. в разделе Моментальные снимки Amazon EBS в Руководстве пользователя Amazon EBS.

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

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

Синтаксис

  describe-snapshots
[--owner-ids <value>]
[--restorable-by-user-ids <value>]
[--snapshot-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]

Параметры

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

Синтаксис:

"string" "string" ...

--restorable-by-user-ids (список)

Синтаксис:

"string" "string" ...

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

Синтаксис:

"string" "string" ...

--dry-run | --no-dry-run (булево)

--filters (список)

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

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 (строка)

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

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

--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 по умолчанию команды указанным 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.

Примеры

Пример 1: Описание снимка

Следующий describe-snapshots пример описывает указанный снимок.

aws ec2 describe-snapshots \
    --snapshot-ids snap-1234567890abcdef0

Вывод:

{
    "Snapshots": [
        {
            "Description": "This is my snapshot",
            "Encrypted": false,
            "VolumeId": "vol-049df61146c4d7901",
            "State": "completed",
            "VolumeSize": 8,
            "StartTime": "2019-02-28T21:28:32.000Z",
            "Progress": "100%",
            "OwnerId": "012345678910",
            "SnapshotId": "snap-01234567890abcdef",
            "Tags": [
                {
                    "Key": "Stack",
                    "Value": "test"
                }
            ]
        }
    ]
}

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

Пример 2: Описание снимков на основе фильтров

Следующий describe-snapshots пример использует фильтры, чтобы сузить результаты до снимков, принадлежащих вашей учетной записи AWS, которые находятся в состоянии pending. В примере используется параметр --query для отображения только идентификаторов снимков и времени их создания.

aws ec2 describe-snapshots \
    --owner-ids self \
    --filters Name=status,Values=pending \
    --query "Snapshots[*].{ID:SnapshotId,Time:StartTime}"

Вывод:

[
    {
        "ID": "snap-1234567890abcdef0",
        "Time": "2019-08-04T12:48:18.000Z"
    },
    {
        "ID": "snap-066877671789bd71b",
        "Time": "2019-08-04T02:45:16.000Z
    },
    ...
]

В следующем describe-snapshots примере используются фильтры для ограничения результатов снимками, созданными из указанного тома. В примере используется параметр --query для отображения только идентификаторов снимков.

aws ec2 describe-snapshots \
    --filters Name=volume-id,Values=049df61146c4d7901 \
    --query "Snapshots[*].[SnapshotId]" \
    --output text

Вывод:

snap-1234567890abcdef0
snap-08637175a712c3fb9
...

Дополнительные примеры использования фильтров см. в разделе «Перечисление и фильтрация ресурсов» в Руководстве пользователя Amazon EC2.

Пример 3: Описание снимков на основе тегов

Следующий describe-snapshots пример использует фильтры по тегам для ограничения результатов снимками, имеющими тег Stack=Prod.

aws ec2 describe-snapshots \
    --filters Name=tag:Stack,Values=prod

Пример вывода для describe-snapshots см. в Примере 1.

Дополнительные примеры использования фильтров по тегам см. в разделе «Работа с тегами» в Руководстве пользователя Amazon EC2.

Пример 4: Описание снимков на основе возраста

Следующий describe-snapshots пример использует выражения JMESPath для описания всех снимков, созданных вашей учетной записью AWS до указанной даты. Отображаются только идентификаторы снимков.

aws ec2 describe-snapshots \
    --owner-ids 012345678910 \
    --query "Snapshots[?(StartTime<='2020-03-31')].[SnapshotId]"

Дополнительные примеры использования фильтров см. в разделе «Перечисление и фильтрация ресурсов» в Руководстве пользователя Amazon EC2.

Пример 5: Просмотр только архивных снимков

Следующий describe-snapshots пример отображает только снимки, хранящиеся в архиве.

aws ec2 describe-snapshots \
    --filters "Name=storage-tier,Values=archive"

Вывод:

{
    "Snapshots": [
        {
            "Description": "Snap A",
            "Encrypted": false,
            "VolumeId": "vol-01234567890aaaaaa",
            "State": "completed",
            "VolumeSize": 8,
            "StartTime": "2021-09-07T21:00:00.000Z",
            "Progress": "100%",
            "OwnerId": "123456789012",
            "SnapshotId": "snap-01234567890aaaaaa",
            "StorageTier": "archive",
            "Tags": []
        },
    ]
}

Дополнительную информацию см. в разделе «Просмотр архивных снимков» в Руководстве пользователя Amazon Elastic Compute Cloud.

Вывод

NextToken -> (строка)

Snapshots -> (список)