Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

Сводки о заданиях резервного копирования

Описание

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

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

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

Синтаксис

  list-backup-job-summaries
[--account-id <value>]
[--state <value>]
[--resource-type <value>]
[--message-category <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 агрегирует количество заданий для всех состояний и возвращает сумму.

Completed with issues — это статус, встречающийся только в консоли резервного копирования. В API этот статус относится к заданиям со статусом COMPLETED и MessageCategory со значением, отличным от SUCCESS; то есть статус завершён, но сопровождается сообщением о статусе. Чтобы получить количество заданий для Completed with issues, выполните два запроса GET и вычтите из большего значения меньшее:

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

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

  • CREATED
  • PENDING
  • RUNNING
  • ABORTING
  • ABORTED
  • COMPLETED
  • FAILED
  • EXPIRED
  • PARTIAL
  • AGGREGATE_ALL
  • ANY

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

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

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

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

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

--message-category (строка)

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

Примеры допустимых строк включают AccessDenied, Success и InvalidParameters. Список допустимых строк MessageCategory см. в разделе Мониторинг.

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

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

--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 позволяет вернуть больше элементов в вашем списке, начиная с местоположения, указанного маркером.

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

Вывод

BackupJobSummaries -> (список)

Сводная информация.

(структура)

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

Возвращаемая сводка может содержать Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime и количество включенных заданий.

Region -> (строка)

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

AccountId -> (строка)

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

State -> (строка)

Это значение — количество заданий для заданного состояния.

ResourceType -> (строка)

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

MessageCategory -> (строка)

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

Примеры строк включают AccessDenied, Success и InvalidParameters. Список строк MessageCategory см. в разделе Мониторинг.

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

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

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

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

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

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

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

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

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

Это значение — время в формате Unix, Coordinated Universal Time (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.

Spec-Zone.ru

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