Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

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

Возвращает только задачи восстановления с указанным статусом.

Возможные значения:

  • PENDING
  • RUNNING
  • COMPLETED
  • ABORTED
  • FAILED

--by-complete-before (метка времени)

Возвращает только задачи копирования, завершённые до указанной даты в формате Unix и в формате Coordinated Universal Time (UTC).

--by-complete-after (метка времени)

Возвращает только задачи копирования, завершённые после указанной даты в формате Unix и в формате Coordinated Universal Time (UTC).

--by-restore-testing-plan-arn (строка)

Возвращает только тестовые задачи восстановления, соответствующие указанному Amazon Resource Name (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, идентифицирующий точку восстановления; например, 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.

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

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

Status -> (строка)

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

StatusMessage -> (строка)

Подробное сообщение, объясняющее состояние задачи восстановления точки восстановления.

PercentDone -> (строка)

Содержит приблизительный процент завершённости задачи на момент запроса статуса задачи.

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

Размер восстановленного ресурса в байтах.

IamRoleArn -> (строка)

ARN роли IAM, используемой для создания целевой точки восстановления; например, arn:aws:iam::123456789012:role/S3Access.

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

Ожидаемое время восстановления точки восстановления в минутах.

CreatedResourceArn -> (строка)

Имя ресурса Amazon (ARN), уникально идентифицирующее ресурс. Формат ARN зависит от типа ресурса.

ResourceType -> (строка)

Тип ресурса перечисленных задач восстановления; например, том Amazon Elastic Block Store (Amazon EBS) или база данных Amazon Relational Database Service (Amazon RDS). Для резервных копий Windows Volume Shadow Copy Service (VSS) поддерживается только тип ресурса Amazon EC2.

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

Дата создания точки восстановления.

CreatedBy -> (структура)

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

RestoreTestingPlanArn -> (строка)

ARN ресурса Amazon, который уникально идентифицирует план тестирования восстановления.

ValidationStatus -> (строка)

Статус проверки указанной задачи восстановления.

ValidationStatusMessage -> (строка)

Описание статуса проверки указанной задачи восстановления.

DeletionStatus -> (строка)

Статус данных, сгенерированных тестом восстановления. Статус может быть Deleting, Failed или Successful.

DeletionStatusMessage -> (строка)

Описание статуса удаления задачи восстановления.

NextToken -> (строка)

Следующий элемент после частичного списка возвращённых элементов. Например, если требуется вернуть MaxResults число элементов, NextToken позволяет вернуть больше элементов в списке, начиная с местоположения, указанного в токенах.

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

Spec-Zone.ru

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