Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-db-instance-automated-backups

Описание

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

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

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

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

Синтаксис

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

Параметры

--dbi-resource-id (строка)

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

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

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

--filters (список)

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

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

  • status
    • active — Автоматические резервные копии для текущих экземпляров.
    • creating — Автоматические резервные копии, ожидающие готовности первого автоматического снимка.
    • retained — Автоматические резервные копии для удаленных экземпляров и после остановки репликации резервных копий.
  • db-instance-id — Принимает идентификаторы экземпляров БД и имена ресурсов Amazon (ARN). Список результатов включает только информацию об автоматических резервных копиях экземпляров БД, идентифицированных этими ARN.
  • dbi-resource-id — Принимает идентификаторы ресурсов БД и имена ресурсов Amazon (ARN). Список результатов включает только информацию о ресурсах экземпляров БД, идентифицированных этими ARN.

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

(структура)

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

Примечание

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

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

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

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

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

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

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

(строка)

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

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

Синтаксис JSON:

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

--db-instance-automated-backups-arn (строка)

Имя ресурса Amazon (ARN) реплицированных автоматических резервных копий, например, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

Это значение не применяется к RDS Custom.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, во всех примерах используются правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Чтобы описать автоматические резервные копии экземпляра БД

Следующий пример describe-db-instance-automated-backups отображает подробную информацию об автоматических резервных копиях указанного экземпляра БД. Сведения включают реплицированные автоматические резервные копии в других регионах AWS.

aws rds describe-db-instance-automated-backups \
    --db-instance-identifier new-orcl-db

Вывод:

{
    "DBInstanceAutomatedBackups": [
        {
            "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
            "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
            "Region": "us-east-1",
            "DBInstanceIdentifier": "new-orcl-db",
            "RestoreWindow": {
                "EarliestTime": "2020-12-07T21:05:20.939Z",
                "LatestTime": "2020-12-07T21:05:20.939Z"
            },
            "AllocatedStorage": 20,
            "Status": "replicating",
            "Port": 1521,
            "InstanceCreateTime": "2020-12-04T15:28:31Z",
            "MasterUsername": "admin",
            "Engine": "oracle-se2",
            "EngineVersion": "12.1.0.2.v21",
            "LicenseModel": "bring-your-own-license",
            "OptionGroupName": "default:oracle-se2-12-1",
            "Encrypted": false,
            "StorageType": "gp2",
            "IAMDatabaseAuthenticationEnabled": false,
            "BackupRetentionPeriod": 14,
            "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"
        }
    ]
}

Дополнительную информацию см. в разделе Поиск информации о реплицированных резервных копиях в Руководстве пользователя Amazon RDS.

Вывод

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

Необязательный маркер страницы, предоставленный в предыдущем запросе. Если этот параметр указан, в ответе содержатся только записи, начиная с маркера, до значения, указанного параметром MaxRecords .

DBInstanceAutomatedBackups -> (список)

Список экземпляров DBInstanceAutomatedBackup .

(структура)

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

DBInstanceArn -> (строка)

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

DbiResourceId -> (строка)

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

Region -> (строка)

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

DBInstanceIdentifier -> (строка)

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

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

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

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

Наименьшее время для восстановления экземпляра.

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

Наибольшее время для восстановления экземпляра.

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

Размер выделенного хранилища для резервного копирования в гибибайтах (GiB).

Status -> (строка)

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

  • active - Автоматические резервные копии для текущих экземпляров.
  • retained - Автоматические резервные копии для удалённых экземпляров.
  • creating - Автоматические резервные копии, ждущие готовности первого автоматического снимка.

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

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

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

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

AvailabilityZone -> (строка)

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

VpcId -> (строка)

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

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

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

MasterUsername -> (строка)

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

Engine -> (строка)

Название СУБД для этого резервного копирования.

EngineVersion -> (строка)

Версия СУБД для резервного копирования.

LicenseModel -> (строка)

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

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

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

OptionGroupName -> (строка)

Группа параметров, с которой связано резервное копирование. Если опущено, используется групповые параметры по умолчанию для указанной СУБД.

TdeCredentialArn -> (строка)

ARN из хранилища ключей, с которым связано автоматическое резервное копирование для шифрования TDE.

Encrypted -> (логическое значение)

Указывает, зашифровано ли автоматическое резервное копирование.

StorageType -> (строка)

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

KmsKeyId -> (строка)

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

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

Timezone -> (строка)

Часовой пояс резервного копирования. В большинстве случаев элемент Timezone пуст. Timezone контент отображается только для экземпляров баз данных Microsoft SQL Server, которые были созданы со специфицированным часовым поясом.

IAMDatabaseAuthenticationEnabled -> (логическое значение)

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

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

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

DBInstanceAutomatedBackupsArn -> (строка)

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

DBInstanceAutomatedBackupsReplications -> (список)

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

(структура)

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

DBInstanceAutomatedBackupsArn -> (строка)

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

BackupTarget -> (строка)

Место хранения автоматических резервных копий: Amazon Web Services Outposts или регион Amazon Web Services.

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

Производительность хранилища для резервного копирования.

AwsBackupRecoveryPointArn -> (строка)

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

DedicatedLogVolume -> (логическое значение)

Указывает, включен ли выделенный том журналов (DLV) для экземпляра базы данных.

MultiTenant -> (логическое значение)

Указывает, является ли автоматическое резервное копирование для экземпляра базы данных в многопользовательской конфигурации (ИСТИНА) или в однопользовательской конфигурации (ЛОЖЬ).

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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