Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

list-recovery-points-by-resource

Описание

Информация о точках восстановления указанного типа с помощью Amazon Resource Name (ARN) ресурса.

Примечание

Для Amazon EFS и Amazon EC2 этот параметр отображает только точки восстановления, созданные Backup.

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

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

Синтаксис

  list-recovery-points-by-resource
--resource-arn <value>
[--managed-by-aws-backup-only | --no-managed-by-aws-backup-only]
[--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]

Параметры

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

ARN, однозначно определяющий ресурс. Формат ARN зависит от типа ресурса.

--managed-by-aws-backup-only | --no-managed-by-aws-backup-only (логическое значение)

Этот атрибут фильтрует точки восстановления на основе принадлежности.

Если установлено значение TRUE, ответ будет содержать точки восстановления, связанные с выбранными ресурсами, управляемыми Backup.

Если установлено значение FALSE, ответ будет содержать все точки восстановления, связанные с выбранным ресурсом.

Тип: Логическое значение

--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 -> (список)

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

Примечание

Только Amazon EFS и Amazon EC2 точки восстановления возвращают BackupVaultName.

(структура)

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

RecoveryPointArn -> (строка)

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

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

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

Status -> (строка)

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

StatusMessage -> (строка)

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

EncryptionKeyArn -> (строка)

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

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

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

BackupVaultName -> (строка)

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

IsParent -> (логическое значение)

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

ParentRecoveryPointArn -> (строка)

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

ResourceName -> (строка)

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

VaultType -> (строка)

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

IndexStatus -> (строка)

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

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

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

IndexStatusMessage -> (строка)

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

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

Spec-Zone.ru

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