Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

list-recovery-points-by-backup-vault

Описание

Возвращает подробную информацию о точках восстановления, хранящихся в хранилище резервных копий.

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

list-recovery-points-by-backup-vault является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос аргумент --query должен извлекать данные из результатов следующих выражений запроса: RecoveryPoints

Синтаксис

  list-recovery-points-by-backup-vault
--backup-vault-name <value>
[--backup-vault-account-id <value>]
[--by-resource-arn <value>]
[--by-resource-type <value>]
[--by-backup-plan-id <value>]
[--by-created-before <value>]
[--by-created-after <value>]
[--by-parent-recovery-point-arn <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]

Параметры

--backup-vault-name (строка)

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

Примечание

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

--backup-vault-account-id (строка)

Этот параметр отсортирует список точек восстановления по идентификатору учетной записи.

--by-resource-arn (строка)

Возвращает только точки восстановления, соответствующие указанному Amazon Resource Name (ARN) ресурса.

--by-resource-type (строка)

Возвращает только точки восстановления, соответствующие указанному типу(ам) ресурса:

  • Aurora для Amazon Aurora
  • CloudFormation для CloudFormation
  • DocumentDB для Amazon DocumentDB (с совместимостью MongoDB)
  • DynamoDB для Amazon DynamoDB
  • EBS для Amazon Elastic Block Store
  • EC2 для Amazon Elastic Compute Cloud
  • EFS для Amazon Elastic File System
  • FSx для Amazon FSx
  • Neptune для Amazon Neptune
  • RDS для Amazon Relational Database Service
  • Redshift для Amazon Redshift
  • S3 для Amazon Simple Storage Service (Amazon S3)
  • SAP HANA on Amazon EC2 для баз данных SAP HANA на экземплярах Amazon Elastic Compute Cloud
  • Storage Gateway для Storage Gateway
  • Timestream для Amazon Timestream
  • VirtualMachine для виртуальных машин VMware

--by-backup-plan-id (строка)

Возвращает только точки восстановления, соответствующие указанному идентификатору плана резервного копирования.

--by-created-before (метка времени)

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

--by-created-after (метка времени)

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

--by-parent-recovery-point-arn (строка)

Возвращает только точки восстановления, соответствующие указанному родительскому (составному) Amazon Resource Name (ARN) точки восстановления.

--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 для вывода.

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

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

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

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

Вывод

NextToken -> (строка)

Следующий элемент после частичного списка возвращённых элементов. Например, если запрос направлен на возврат MaxResults количества элементов, NextToken позволяет вернуть больше элементов в вашем списке, начиная с позиции, указанной следующим маркером.

RecoveryPoints -> (список)

Массив объектов, содержащих подробную информацию о точках восстановления, сохранённых в хранилище резервных копий.

(структура)

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

RecoveryPointArn -> (строка)

Идентификатор Amazon Resource Name (ARN), уникально идентифицирующий точку восстановления; например, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .

BackupVaultName -> (строка)

Имя логической контейнера, где хранятся резервные копии. Хранилища резервных копий идентифицируются именами, уникальными для учётной записи, используемой для их создания, и региона Amazon Web Services, где они созданы.

BackupVaultArn -> (строка)

ARN, уникально идентифицирующий хранилище резервных копий; например, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault .

SourceBackupVaultArn -> (строка)

Хранилище резервных копий, откуда была изначально скопирована точка восстановления. Если точка восстановления восстанавливается в той же учётной записи, это значение будет null .

ResourceArn -> (строка)

ARN, уникально идентифицирующий ресурс. Формат ARN зависит от типа ресурса.

ResourceType -> (строка)

Тип ресурса Amazon Web Services, сохранённого в качестве точки восстановления; например, объём Amazon Elastic Block Store (Amazon EBS) или база данных Amazon Relational Database Service (Amazon RDS). Для резервных копий Windows Volume Shadow Copy Service (VSS) единственный поддерживаемый тип ресурса — Amazon EC2.

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

Содержит идентификационную информацию о создании точки восстановления, включая BackupPlanArn , BackupPlanId , BackupPlanVersion и BackupRuleId плана резервного копирования, используемого для её создания.

BackupPlanId -> (строка)

Уникально идентифицирует план резервного копирования.

BackupPlanArn -> (строка)

Идентификатор Amazon Resource Name (ARN), уникально идентифицирующий план резервного копирования; например, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .

BackupPlanVersion -> (строка)

Идентификаторы версий — уникальные, случайным образом сгенерированные, кодированные в Unicode, UTF-8 строки длиной не более 1024 байт. Они не могут быть изменены.

BackupRuleId -> (строка)

Уникально идентифицирует правило, используемое для планирования резервного копирования выбранных ресурсов.

IamRoleArn -> (строка)

Указывает ARN роли IAM, используемой для создания целевой точки восстановления; например, arn:aws:iam::123456789012:role/S3Access .

Status -> (строка)

Код состояния, определяющий состояние точки восстановления.

StatusMessage -> (строка)

Сообщение, объясняющее текущее состояние точки восстановления.

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

Дата и время создания точки восстановления в формате Unix и координированном всемирном времени (UTC). Значение CreationDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

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

Дата и время завершения задачи восстановления точки восстановления в формате Unix и координированном всемирном времени (UTC). Значение CompletionDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

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

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

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

Объект CalculatedLifecycle, содержащий временные метки DeleteAt и MoveToColdStorageAt.

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

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

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

Временная метка, указывающая, когда удалить точку восстановления.

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

Жизненный цикл определяет, когда защищённый ресурс переносится в холодное хранилище и когда он истекает. Переходы резервных копий и истечение срока действия резервных копий автоматически происходят в соответствии с определённым вами жизненным циклом.

Резервные копии, переведённые в холодное хранилище, должны храниться в нём не менее 90 дней. Поэтому значение «retention» должно быть на 90 дней больше значения «transition to cold after days». Значение «transition to cold after days» нельзя изменить после того, как резервная копия была переведена в холодное хранилище.

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

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

Количество дней после создания, по истечении которых точка восстановления перемещается в холодное хранилище.

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

Количество дней после создания, по истечении которых точка восстановления удаляется. Это значение должно быть как минимум на 90 дней больше, чем значение, указанное в MoveToColdStorageAfterDays .

OptInToArchiveForSupportedResources -> (булево)

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

EncryptionKeyArn -> (строка)

Ключ шифрования на стороне сервера, используемый для защиты ваших резервных копий; например, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

IsEncrypted -> (булево)

Булево значение, возвращаемое как TRUE, если указанная точка восстановления зашифрована, или как FALSE, если точка восстановления не зашифрована.

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

Дата и время последнего восстановления точки восстановления в формате Unix и координированном всемирном времени (UTC). Значение LastRestoreTime точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

ParentRecoveryPointArn -> (строка)

Идентификатор Amazon Resource Name (ARN) родительской (составной) точки восстановления.

CompositeMemberIdentifier -> (строка)

Идентификатор ресурса в составе группы, такой как вложенная (дочерняя) точка восстановления, принадлежащая составной (родительской) структуре. Идентификатор передаётся из логического идентификатора в рамках структуры.

IsParent -> (булево)

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

ResourceName -> (строка)

Неуникальное имя ресурса, принадлежащего указанной резервной копии.

VaultType -> (строка)

Тип хранилища, в котором хранится описанная точка восстановления.

IndexStatus -> (строка)

Текущее состояние индекса резервной копии, связанного с указанной точкой восстановления.

Состояния: PENDING | ACTIVE | FAILED | DELETING

Точка восстановления с индексом, имеющим состояние ACTIVE, может быть включена в поиск.

IndexStatusMessage -> (строка)

Строка с подробным сообщением, объясняющим состояние индекса резервной копии, связанного с точкой восстановления.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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