Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-db-cluster-automated-backups

Описание

Отображает резервные копии как для текущих, так и для удалённых баз данных. Например, используйте эту операцию, чтобы найти подробности о плановых резервных копиях для ранее удалённых кластеров. Текущие кластеры возвращаются для операций DescribeDBClusterAutomatedBackups и DescribeDBClusters.

Все параметры являются необязательными.

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

describe-db-cluster-automated-backups является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DBClusterAutomatedBackups

Синтаксис

  describe-db-cluster-automated-backups
[--db-cluster-resource-id <value>]
[--db-cluster-identifier <value>]
[--filters <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]

Параметры

--db-cluster-resource-id (строка)

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

--db-cluster-identifier (строка)

(Необязательно) Указанный пользователем идентификатор кластера базы данных. Если этот параметр указан, он должен соответствовать идентификатору существующего кластера базы данных. Он возвращает информацию о плановой резервной копии конкретного кластера базы данных. Этот параметр нечувствителен к регистру.

--filters (список)

Фильтр, определяющий, какие ресурсы возвращать на основе статуса.

Поддерживаемые фильтры следующие:

  • status
    • retained - Плановые резервные копии для удалённых кластеров и после остановки репликации резервных копий.
  • db-cluster-id - Принимает идентификаторы кластеров базы данных и Amazon Resource Names (ARN). Список результатов включает только информацию о плановых резервных копиях кластера базы данных, идентифицированных этими ARN.
  • db-cluster-resource-id - Принимает идентификаторы ресурсов базы данных и Amazon Resource Names (ARN). Список результатов включает только информацию о ресурсах кластера базы данных, идентифицированных этими ARN.

По умолчанию возвращает все ресурсы. Статус каждого ресурса указан в ответе.

(структура)

Пара имя-значение фильтра, используемая для возвращения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определённым критериям, например, по идентификаторам. Фильтры, поддерживаемые операцией describe, документированы вместе с операцией describe.

Примечание

В настоящее время в фильтрах не поддерживаются подстановочные знаки.

Следующие действия могут быть отфильтрованы:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

Сокращённый синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

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

Вывод

Маркер -> (строка)

Маркер страницы, предоставленный в предыдущем запросе. Если этот параметр указан, ответ включает только записи за маркером, до MaxRecords .

DBClusterAutomatedBackups -> (список)

Список DBClusterAutomatedBackup резервных копий.

(структура)

Автоматическая резервная копия кластера баз данных. Она состоит из системных резервных копий, журналов транзакций и свойств кластера баз данных, существовавших в момент удаления исходного кластера.

Двигатель -> (строка)

Название движка базы данных для этой автоматической резервной копии.

VpcId -> (строка)

Идентификатор VPC, связанный с кластером баз данных.

DBClusterAutomatedBackupsArn -> (строка)

Amazon Resource Name (ARN) для автоматических резервных копий.

DBClusterIdentifier -> (строка)

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

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

Начальное и конечное время, к которому можно восстановить экземпляр:

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

Начальное время, к которому можно восстановить экземпляр.

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

Конечное время, к которому можно восстановить экземпляр.

MasterUsername -> (строка)

Имя пользователя мастера для автоматической резервной копии.

DbClusterResourceId -> (строка)

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

Region -> (строка)

Регион Amazon Web Services, связанный с автоматической резервной копией.

LicenseModel -> (строка)

Информация о лицензионной модели для этой автоматической резервной копии кластера баз данных.

Статус -> (строка)

Список информации о статусе автоматической резервной копии:

  • retained - Автоматические резервные копии для удаленных кластеров.

IAMDatabaseAuthenticationEnabled -> (булево)

Указывает, включена ли привязка учетных записей Amazon Web Services Identity and Access Management (IAM) к учетным записям базы данных.

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

Время создания кластера баз данных в формате Coordinated Universal Time (UTC).

StorageEncrypted -> (булево)

Указывает, зашифрован ли исходный кластер баз данных.

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

Для всех движков баз данных, кроме Amazon Aurora, AllocatedStorage указывает размер выделенного хранилища в гигабайтах (GiB). Для Aurora AllocatedStorage всегда возвращает 1, так как размер хранилища кластера баз данных Aurora не фиксирован, а автоматически настраивается по мере необходимости.

EngineVersion -> (строка)

Версия движка базы данных для автоматической резервной копии.

DBClusterArn -> (строка)

Amazon Resource Name (ARN) для исходного кластера баз данных.

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

Срок хранения автоматических резервных копий.

EngineMode -> (строка)

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

AvailabilityZones -> (список)

Доступные зоны, где можно создать экземпляры в кластере баз данных. Сведения о регионах и доступных зонах Amazon Web Services см. в разделе Регионы и доступные зоны.

(строка)

Порт -> (целое число)

Номер порта, используемый автоматической резервной копией для подключений.

По умолчанию: наследуется от исходного кластера баз данных.

Допустимые значения: 1150-65535

KmsKeyId -> (строка)

Идентификатор ключа Amazon Web Services KMS для автоматической резервной копии.

Идентификатор ключа Amazon Web Services KMS — это ARN ключа, ID ключа, ARN псевдонима или имя псевдонима ключа KMS.

StorageType -> (строка)

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

Это значение применяется только для не-Aurora Multi-AZ кластеров баз данных.

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

Значение IOPS (операций ввода-вывода в секунду) для автоматической резервной копии.

Это значение применяется только для не-Aurora Multi-AZ кластеров баз данных.

AwsBackupRecoveryPointArn -> (строка)

Amazon Resource Name (ARN) точки восстановления в Amazon Web Services Backup.

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

Пропускная способность хранилища для автоматической резервной копии. Пропускная способность автоматически настраивается на основе предоставленных IOPS и не настраивается.

Это значение применяется только для не-Aurora Multi-AZ кластеров баз данных.

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

Spec-Zone.ru

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