Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

list-restore-job-summaries

Описание

Этот запрос получает сводку по заданиям восстановления, созданным или выполняемым в течение последних 30 дней. Вы можете использовать параметры AccountID, State, ResourceType, AggregationPeriod, MaxResults или NextToken для фильтрации результатов.

Этот запрос возвращает сводку, содержащую Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime и Count включенных заданий.

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

Синтаксис

  list-restore-job-summaries
[--account-id <value>]
[--state <value>]
[--resource-type <value>]
[--aggregation-period <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--account-id (строка)

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

Если запрос отправляется от аккаунта-члена или аккаунта, не являющегося частью Amazon Web Services Organizations, будут возвращены задания в аккаунте отправителя запроса.

Корневые, администраторские и делегированные администраторские аккаунты могут использовать значение ANY, чтобы получить количество заданий для каждого аккаунта в организации.

AGGREGATE_ALL агрегирует количество заданий всех аккаунтов в авторизованной организации и возвращает сумму.

--state (строка)

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

Значение ANY возвращает количество заданий всех состояний.

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

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

  • CREATED
  • PENDING
  • RUNNING
  • ABORTED
  • COMPLETED
  • FAILED
  • AGGREGATE_ALL
  • ANY

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

Возвращает количество заданий для указанного типа ресурса. Используйте запрос GetSupportedResourceTypes для получения строк поддерживаемых типов ресурсов.

Значение ANY возвращает количество заданий всех типов ресурсов.

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

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

--aggregation-period (строка)

Период для возвращаемых результатов.

  • ONE_DAY - Количество заданий в день за последние 14 дней.
  • SEVEN_DAYS - Агрегированное количество заданий за последние 7 дней.
  • FOURTEEN_DAYS - Агрегированное количество заданий за последние 14 дней.

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

  • ONE_DAY
  • SEVEN_DAYS
  • FOURTEEN_DAYS

--max-results (целое число)

Этот параметр устанавливает максимальное количество возвращаемых элементов.

Значение — целое число. Диапазон допустимых значений от 1 до 500.

--next-token (строка)

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

--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 (boolean)

Включить отладовую запись в журнал.

--endpoint-url (string)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

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

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить вывод цвета.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться в режиме блокировки без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться в режиме блокировки без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросить входные параметры CLI.

Вывод

RestoreJobSummaries -> (список)

Этот результат содержит сводку, включающую регион, учётную запись, состояние, тип ресурса, категорию сообщения, начальное время, конечное время и количество включённых задач.

(структура)

Это сводка задач восстановления, созданных или выполняемых в течение последних 30 дней.

Возвращаемая сводка может содержать: регион, учётную запись, состояние, тип ресурса, категорию сообщения, начальное время, конечное время и количество включённых задач.

Region -> (строка)

Регионы Amazon Web Services в сводке задач.

AccountId -> (строка)

Идентификатор учётной записи, которой принадлежат задачи в сводке.

State -> (строка)

Это значение — количество задач со указанным состоянием.

ResourceType -> (строка)

Это значение — количество задач для указанного типа ресурса. Запрос GetSupportedResourceTypes возвращает строки для поддерживаемых типов ресурсов.

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

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

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

Значение времени в числовом формате начального времени задачи.

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

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

Значение времени в числовом формате конечного времени задачи.

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

AggregationPeriod -> (строка)

Период для возвращаемых результатов.

  • ONE_DAY - Количество задач ежедневно за последние 14 дней.
  • SEVEN_DAYS - Суммарное количество задач за последние 7 дней.
  • FOURTEEN_DAYS - Суммарное количество задач за последние 14 дней.

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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