describe-db-snapshot-tenant-databases
Описание
Описывает базовые данные арендаторов, которые существуют в снимке БД. Эта команда применяется только к экземплярам RDS для Oracle DB в конфигурации с несколькими арендаторами.
Вы можете использовать эту команду для проверки баз данных арендаторов в снимке перед его восстановлением. Вы не можете напрямую взаимодействовать с базами данных арендаторов в снимке БД. Если вы восстанавливаете снимок, который был сделан из экземпляра БД с использованием конфигурации с несколькими арендаторами, вы восстанавливаете все его базовые данные арендаторов.
См. также: Документацию API AWS
describe-db-snapshot-tenant-databases является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запросов: DBSnapshotTenantDatabases
Синтаксис
describe-db-snapshot-tenant-databases
[--db-instance-identifier <value>]
[--db-snapshot-identifier <value>]
[--snapshot-type <value>]
[--filters <value>]
[--dbi-resource-id <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-instance-identifier (строка)
Идентификатор экземпляра БД, используемого для создания снимков БД. Этот параметр не чувствителен к регистру.
Ограничения:
- При указании должен совпадать с идентификатором существующего
DBInstance.
--db-snapshot-identifier (строка)
Идентификатор снимка БД, содержащего базовые данные арендаторов для описания. Это значение хранится как строка в нижнем регистре.
Ограничения:
- Если вы указываете этот параметр, значение должно совпадать с идентификатором существующего снимка БД.
- Если вы указываете автоматический снимок, вы также должны указать
SnapshotType.
--snapshot-type (строка)
Тип снимков БД, которые должны быть возвращены. Вы можете указать одно из следующих значений:
-
automated– Все снимки БД, которые автоматически были сделаны Amazon RDS для моей учетной записи Amazon Web Services. -
manual– Все снимки БД, которые были сделаны моей учетной записью Amazon Web Services. -
shared– Все ручные снимки БД, которые были предоставлены моей учетной записи Amazon Web Services. -
public– Все снимки БД, которые были помечены как общедоступные. -
awsbackup– Все снимки БД, управляемые службой резервного копирования Amazon Web Services.
--filters (список)
Фильтр, который определяет одну или несколько баз данных арендаторов для описания.
Поддерживаемые фильтры:
-
tenant-db-name- Имена баз данных арендаторов. В результатах списка отображается только информация о базах данных арендаторов, которые соответствуют этим именам баз данных арендаторов. -
tenant-database-resource-id- Идентификаторы ресурсов баз данных арендаторов. В списке результатов отображается только информация о базах данных арендаторов, содержащихся в снимках БД. -
dbi-resource-id- Идентификаторы ресурсов экземпляров БД. В списке результатов отображается только информация о снимках, содержащих базовые данные арендаторов, содержащиеся в экземплярах БД, идентифицированных этими идентификаторами ресурсов. -
db-instance-id- Принимает идентификаторы экземпляров БД и Amazon Resource Names (ARN) экземпляров БД. -
db-snapshot-id- Принимает идентификаторы снимков БД. -
snapshot-type- Принимает типы снимков БД.
(структура)
Пара имя-значение фильтра, используемая для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для соответствия набору ресурсов по определенным критериям, таким как идентификаторы. Фильтры, поддерживаемые операцией describe, документированы с операцией describe.
Примечание
В настоящее время в фильтрах не поддерживаются символы подстановки.Следующие действия могут быть отфильтрованы:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribeDBRecommendationsDescribeDBShardGroupsDescribePendingMaintenanceActions
Имя -> (строка)
Значения -> (список)
Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.
(строка)
Сокращенный синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--dbi-resource-id (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращенных в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.
--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 (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию - 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения к сокету в секундах. Если значение установлено в 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.DBSnapshotTenantDatabases -> (список)
Список баз данных арендаторов снимка БД.
(структура)
Содержит сведения о базе данных арендатора в снимке экземпляра БД.
DBSnapshotIdentifier -> (строка)
DBInstanceIdentifier -> (строка)
DbiResourceId -> (строка)
EngineName -> (строка)
SnapshotType -> (строка)
TenantDatabaseCreateTime -> (временная метка)
TenantDBName -> (строка)
MasterUsername -> (строка)
TenantDatabaseResourceId -> (строка)
CharacterSetName -> (строка)
DBSnapshotTenantDatabaseARN -> (строка)
NcharCharacterSetName -> (строка)
NCHAR базы данных арендатора.TagList -> (список)
Список тегов.
Дополнительную информацию см. в разделе Маркирование ресурсов Amazon RDS в руководстве пользователя Amazon RDS или в разделе Маркирование ресурсов Amazon Aurora и Amazon RDS в руководстве пользователя Amazon Aurora.
(структура)
Метка, назначенная ресурсу Amazon RDS, состоящая из пары «ключ-значение».
Дополнительную информацию см. в разделе Маркирование ресурсов Amazon RDS в руководстве пользователя Amazon RDS или в разделе Маркирование ресурсов Amazon Aurora и Amazon RDS в руководстве пользователя Amazon Aurora.
Key -> (строка)
aws: или rds:. Строка может содержать только буквы, цифры, пробелы, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).Value -> (строка)
aws: или rds:. Строка может содержать только буквы, цифры, пробелы, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).
© Copyright 2025, Amazon Web Services. Created using Sphinx.