Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

describe-backup-job

Описание

Возвращает подробную информацию о задании резервного копирования для указанного BackupJobId.

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

Синтаксис

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

Уникально идентифицирует запрос Backup для резервного копирования ресурса.

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

Регион для использования. Переопределяет настройки конфигурации/среды.

--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.

Вывод

AccountId -> (строка)

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

BackupJobId -> (строка)

Уникально идентифицирует запрос Backup для резервного копирования ресурса.

BackupVaultName -> (строка)

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

BackupVaultArn -> (строка)

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

RecoveryPointArn -> (строка)

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

ResourceArn -> (строка)

ARN, уникально идентифицирующий сохраненный ресурс. Формат ARN зависит от типа ресурса.

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

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

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

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

State -> (строка)

Текущее состояние задания резервного копирования.

StatusMessage -> (строка)

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

PercentDone -> (строка)

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

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

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

IamRoleArn -> (строка)

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

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

Содержит идентификационную информацию о создании задания резервного копирования, включая BackupPlanArn, BackupPlanId, BackupPlanVersion и BackupRuleId используемого плана резервного копирования.

BackupPlanId -> (строка)

Уникально идентифицирует план резервного копирования.

BackupPlanArn -> (строка)

Amazon Resource Name (ARN), уникально идентифицирующий план резервного копирования; например, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanVersion -> (строка)

Идентификаторы версий представляют собой уникальные, случайные, закодированные в Unicode, UTF-8 строки длиной не более 1024 байт. Их нельзя редактировать.

BackupRuleId -> (строка)

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

ResourceType -> (строка)

Тип Amazon Web Services-ресурса, подлежащего резервному копированию; например, том Amazon Elastic Block Store (Amazon EBS) или база данных Amazon Relational Database Service (Amazon RDS).

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

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

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

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

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

Указывает время в формате Unix и в координированном всемирном времени (UTC), когда задание резервного копирования должно быть запущено до отмены. Значение рассчитывается путем добавления начального интервала к запланированному времени. Таким образом, если запланированное время — 18:00, а начальный интервал — 2 часа, то время StartBy будет 20:00 в указанную дату. Значение StartBy точное до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

BackupOptions -> (словарь)

Представляет параметры, указанные в составе плана резервного копирования или задания резервного копирования по требованию.

key -> (строка)

value -> (строка)

BackupType -> (строка)

Представляет фактический тип резервного копирования, выбранный для задания резервного копирования. Например, если была успешно выполнена резервная копия с помощью Windows Volume Shadow Copy Service (VSS), BackupType возвращает "WindowsVSS". Если BackupType пусто, то тип резервного копирования был обычным.

ParentJobId -> (строка)

Возвращает идентификатор родительского (составного) задания резервного копирования.

IsParent -> (булево)

Возвращает логическое значение, является ли задание резервного копирования родительским (составным).

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

Возвращает количество дочерних (вложенных) заданий резервного копирования.

ChildJobsInState -> (словарь)

Возвращает статистику включенных дочерних (вложенных) заданий резервного копирования.

key -> (строка)

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

ResourceName -> (строка)

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

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

Дата инициирования задания резервного копирования.

MessageCategory -> (строка)

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

Примеры строк могут включать AccessDenied, SUCCESS, AGGREGATE_ALL и INVALIDPARAMETERS. Список допустимых строк MessageCategory см. в мониторинге.

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

Spec-Zone.ru

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