list-restore-jobs
Описание
Возвращает список задач, инициированных Backup для восстановления сохранённого ресурса, включая подробности о процессе восстановления.
См. также: Документацию AWS API
list-restore-jobs является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей, аргумент --query должен извлекать данные из результатов следующих выражений запроса: RestoreJobs
Синтаксис
list-restore-jobs
[--by-account-id <value>]
[--by-resource-type <value>]
[--by-created-before <value>]
[--by-created-after <value>]
[--by-status <value>]
[--by-complete-before <value>]
[--by-complete-after <value>]
[--by-restore-testing-plan-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]
Параметры
--by-account-id (строка)
--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-created-before (метка времени)
--by-created-after (метка времени)
--by-status (строка)
Возвращает только задачи восстановления с указанным статусом.
Возможные значения:
PENDINGRUNNINGCOMPLETEDABORTEDFAILED
--by-complete-before (метка времени)
--by-complete-after (метка времени)
--by-restore-testing-plan-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.
Вывод
RestoreJobs -> (список)
Массив объектов, содержащих подробную информацию о задачах восстановления сохранённых ресурсов.
(структура)
Содержит метаданные о задаче восстановления.
AccountId -> (строка)
RestoreJobId -> (строка)
RecoveryPointArn -> (строка)
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.CreationDate -> (временная метка)
CreationDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 г., 00:11:30.087.CompletionDate -> (временная метка)
CompletionDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 г., 00:11:30.087.Status -> (строка)
StatusMessage -> (строка)
PercentDone -> (строка)
BackupSizeInBytes -> (целое число)
IamRoleArn -> (строка)
arn:aws:iam::123456789012:role/S3Access.ExpectedCompletionTimeMinutes -> (целое число)
CreatedResourceArn -> (строка)
ResourceType -> (строка)
RecoveryPointCreationDate -> (временная метка)
CreatedBy -> (структура)
Содержит идентификационную информацию о создании задачи восстановления.
RestoreTestingPlanArn -> (строка)
ValidationStatus -> (строка)
ValidationStatusMessage -> (строка)
DeletionStatus -> (строка)
Deleting, Failed или Successful.DeletionStatusMessage -> (строка)
NextToken -> (строка)
MaxResults число элементов, NextToken позволяет вернуть больше элементов в списке, начиная с местоположения, указанного в токенах.
© Copyright 2025, Amazon Web Services. Created using Sphinx.