[ aws . cloudhsmv2 ]
describe-backups
Описание
Получает информацию о резервных копиях кластеров CloudHSM. Отображает резервные копии, которые вам принадлежат, или резервные копии, предоставленные вам для совместного использования, когда параметр Shared имеет значение true.
Это операция с постраничной передачей данных, что означает, что каждый ответ может содержать только подмножество всех резервных копий. Когда ответ содержит только подмножество резервных копий, он включает значение NextToken. Используйте это значение в последующем запросе DescribeBackups, чтобы получить больше резервных копий. Когда вы получаете ответ без значения NextToken (или пустое или null значение), это означает, что больше резервных копий получить нельзя.
См. также: AWS API документация
describe-backups является операцией с постраничной передачей данных. Для получения всего набора результатов могут быть выполнены несколько API-запросов. Вы можете отключить постраничную передачу, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей аргумент --query должен извлекать данные из результатов следующих выражений запроса: Backups
Синтаксис
describe-backups
[--filters <value>]
[--shared | --no-shared]
[--sort-ascending | --no-sort-ascending]
[--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]
Параметры
--filters (карта)
Один или несколько фильтров для ограничения элементов, возвращаемых в ответе.
Используйте фильтр backupIds, чтобы вернуть только указанные резервные копии. Укажите резервные копии по их идентификатору (ID).
Используйте фильтр sourceBackupIds, чтобы вернуть только резервные копии, созданные из исходной резервной копии. Идентификатор исходной резервной копии возвращается операцией CopyBackupToRegion.
Используйте фильтр clusterIds, чтобы вернуть только резервные копии для указанных кластеров. Укажите кластеры по их идентификатору (ID).
Используйте фильтр states, чтобы вернуть только резервные копии, соответствующие указанному состоянию.
Используйте фильтр neverExpires, чтобы вернуть резервные копии, отфильтрованные по значению параметра neverExpires. True возвращает все резервные копии, исключенные из политики удержания резервных копий. False возвращает все резервные копии с определенной политикой удержания резервных копий для кластера.
ключ -> (строка)
значение -> (список)
Сокращенный синтаксис:
KeyName1=string,string,KeyName2=string,string
Синтаксис JSON:
{"string": ["string", ...]
...}
--shared | --no-shared (булево)
Описывает резервные копии, которые с вами объединены.
Примечание
По умолчанию, при использовании этого параметра, команда возвращает резервные копии, которые были объединены с помощью стандартного ресурса доступа Resource Access Manager. Для того, чтобы резервная копия, которая была объединенна с помощью команды PutResourcePolicy, была возвращена, объединение должно быть переведено в стандартное объединение ресурсов с помощью API-операции RAM PromoteResourceShareCreatedFromPolicy. Для получения дополнительной информации о совместном использовании резервных копий, см. Раздел "Работа с объединенными резервными копиями" в руководстве пользователя CloudHSM.--sort-ascending | --no-sort-ascending (булево)
--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.
Вывод
РезервныеКопии -> (список)
Список резервных копий.
(структура)
Содержит информацию о резервной копии кластера CloudHSM. Все объекты резервных копий содержат параметры BackupId, BackupState, ClusterId и CreateTimestamp. Резервные копии, которые были скопированы в целевой регион, дополнительно содержат параметры CopyTimestamp, SourceBackup, SourceCluster и SourceRegion. Резервная копия, которая находится в ожидании удаления, будет включать параметр DeleteTimestamp.
BackupId -> (строка)
BackupArn -> (строка)
BackupState -> (строка)
ClusterId -> (строка)
CreateTimestamp -> (временная метка)
CopyTimestamp -> (временная метка)
NeverExpires -> (булево)
True исключает резервную копию из политики удержания. False означает, что служба применяет политику удержания резервных копий, определенную для кластера.SourceRegion -> (строка)
SourceBackup -> (строка)
SourceCluster -> (строка)
DeleteTimestamp -> (временная метка)
TagList -> (список)
Список тегов для резервной копии.
(структура)
Содержит тег. Тег — это пара ключ-значение.
Key -> (строка)
Value -> (строка)
HsmType -> (строка)
Mode -> (строка)
NextToken -> (строка)
DescribeBackups, чтобы получить больше резервных копий.
© Copyright 2025, Amazon Web Services. Created using Sphinx.