Список резервных хранилищ
Описание
Возвращает список контейнеров хранения контрольных точек восстановления вместе с информацией о них.
См. также: Документацию API AWS
list-backup-vaults является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответном документе, содержащем постраничные данные, аргумент --query должен извлекать данные из результатов следующих выражений запроса: BackupVaultList
Синтаксис
list-backup-vaults
[--by-vault-type <value>]
[--by-shared | --no-by-shared]
[--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]
Параметры
--by-vault-type (строка)
Этот параметр отсортирует список хранилищ по типу хранилища.
Возможные значения:
BACKUP_VAULTLOGICALLY_AIR_GAPPED_BACKUP_VAULT
--by-shared | --no-by-shared (логическое значение)
--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 (строка)
Включить/выключить цветной вывод.
- вкл
- выкл
- авто
--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.
Вывод
BackupVaultList -> (список)
Массив членов списка резервного хранилища, содержащий метаданные хранилища, включая Amazon Resource Name (ARN), отображаемое имя, дату создания, количество сохраненных контрольных точек восстановления и информацию об шифровании, если ресурсы, сохраненные в резервном хранилище, зашифрованы.
(структура)
Содержит метаданные о резервном хранилище.
BackupVaultName -> (строка)
BackupVaultArn -> (строка)
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.VaultType -> (строка)
VaultState -> (строка)
CreationDate -> (временная метка)
CreationDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 г., 00:11:30.087.EncryptionKeyArn -> (строка)
Ключ шифрования на стороне сервера, который вы можете указать для шифрования резервных копий из служб, поддерживающих полное управление резервными копиями; например, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. Если вы указываете ключ, вы должны указать его ARN, а не его псевдоним. Если вы не указываете ключ, Backup создаёт ключ KMS по умолчанию.
Чтобы узнать, какие службы Backup поддерживают полное управление резервными копиями и как Backup обрабатывает шифрование резервных копий из служб, которые ещё не поддерживают полное управление резервными копиями, см. Шифрование резервных копий в Backup
CreatorRequestId -> (строка)
Уникальная строка, идентифицирующая запрос и позволяющая повторно выполнить неудачные запросы без риска выполнения операции дважды. Этот параметр необязателен.
Если используется, этот параметр должен содержать от 1 до 50 буквенно-цифровых символов или символов ‘-_.’.
NumberOfRecoveryPoints -> (длинное целое число)
Locked -> (логическое значение)
true, блокировка хранилища предотвращает операции удаления и изменения контрольных точек восстановления в выбранном хранилище.MinRetentionDays -> (длинное целое число)
Настройка Backup Vault Lock, определяющая минимальный срок хранения контрольных точек восстановления хранилищем. Если этот параметр не указан, Vault Lock не накладывает минимальный срок хранения.
Если указано, любая резервная копия или задание копирования в хранилище должны иметь политику жизненного цикла с сроком хранения, равным или большим минимальному сроку хранения. Если срок хранения задания короче минимального срока хранения, то хранилище отклоняет резервную копию или задание копирования, и вам необходимо либо изменить настройки жизненного цикла, либо использовать другое хранилище. Контрольные точки восстановления, уже хранящиеся в хранилище до активации Vault Lock, не затронуты.
MaxRetentionDays -> (длинное целое число)
Настройка Backup Vault Lock, определяющая максимальный срок хранения контрольных точек восстановления хранилищем. Если этот параметр не указан, Vault Lock не накладывает максимальный срок хранения на контрольные точки восстановления в хранилище (разрешая неограниченное хранение).
Если указано, любое задание резервного копирования или копирования в хранилище должно иметь политику жизненного цикла с сроком хранения, равным или меньшим максимальному сроку хранения. Если срок хранения задания больше максимального срока хранения, то хранилище отклоняет задание резервного копирования или копирования, и вам необходимо либо изменить настройки жизненного цикла, либо использовать другое хранилище. Контрольные точки восстановления, уже хранящиеся в хранилище до активации Vault Lock, не затронуты.
LockDate -> (временная метка)
Дата и время, когда конфигурация Backup Vault Lock становится неизменяемой, то есть её нельзя изменить или удалить.
Если вы применили Vault Lock к вашему хранилищу без указания даты блокировки, вы можете изменить настройки Vault Lock или удалить Vault Lock из хранилища в любое время.
Это значение указано в формате Unix, по Гринвичу (UTC) и точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 г., 00:11:30.087.
NextToken -> (строка)
MaxResults элементов, NextToken позволяет возвращать больше элементов в вашем списке, начиная с местоположения, указанного в марке следующей страницы.
© Copyright 2025, Amazon Web Services. Created using Sphinx.