Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

describe-backup-vault

Описание

Возвращает метаданные о хранилище резервных копий, указанном по его имени.

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

Синтаксис

  describe-backup-vault
--backup-vault-name <value>
[--backup-vault-account-id <value>]
[--cli-input-json | --cli-input-yaml]
[--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 (строка)

Идентификатор учетной записи, указанного хранилища резервных копий.

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

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

Используемый регион. Переопределяет настройки config/env.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • автоматически

--no-sign-request (логическое)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Сборник сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

--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-auto-prompt (логическое)

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

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

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

Вывод

BackupVaultName -> (строка)

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

BackupVaultArn -> (строка)

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

VaultType -> (строка)

Тип описанного хранилища.

VaultState -> (строка)

Текущее состояние хранилища.

EncryptionKeyArn -> (строка)

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

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

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

CreatorRequestId -> (строка)

Уникальная строка, идентифицирующая запрос и позволяющая повторно выполнять неудачные запросы без риска выполнения операции дважды. Этот параметр необязателен. Если используется, этот параметр должен содержать от 1 до 50 буквенно-цифровых символов или символов ‘-_.’.

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

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

Locked -> (логическое)

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

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

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

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

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

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

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

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

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

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

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

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

Spec-Zone.ru

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