Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-tenant-databases

Описание

Описывает базы данных арендаторов в экземпляре базы данных, использующем многоарендаторную конфигурацию. Поддерживаются только экземпляры RDS для баз данных Oracle CDB.

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

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

Синтаксис

  describe-tenant-databases
[--db-instance-identifier <value>]
[--tenant-db-name <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-instance-identifier (строка)

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

--tenant-db-name (строка)

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

--filters (список)

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

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

  • tenant-db-name — Имена баз данных арендаторов. Список результатов содержит только информацию о базах данных арендаторов, соответствующих этим именам баз данных арендаторов.
  • tenant-database-resource-id — Идентификаторы ресурсов баз данных арендаторов.
  • dbi-resource-id — Идентификаторы ресурсов экземпляров баз данных. Список результатов содержит только информацию об арендаторах, содержащихся в экземплярах баз данных, идентифицируемых этими идентификаторами ресурсов.

(структура)

Пара имя-значение фильтра, используемый для возврата более конкретного списка результатов из операции 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
  • 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.

Вывод

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

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

TenantDatabases -> (список)

Массив запрошенных баз данных арендаторов операцией DescribeTenantDatabases.

(структура)

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

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

Время создания базы данных арендатора.

DBInstanceIdentifier -> (строка)

Идентификатор экземпляра БД, содержащего базу данных арендатора.

TenantDBName -> (строка)

Имя базы данных арендатора.

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

Статус базы данных арендатора.

MasterUsername -> (строка)

Имя пользователя владельца базы данных арендатора.

DbiResourceId -> (строка)

Уникальный, неизменяемый идентификатор экземпляра БД, свойственный региону Amazon Web Services.

TenantDatabaseResourceId -> (строка)

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

TenantDatabaseARN -> (строка)

Идентификатор ресурса Amazon (ARN) базы данных арендатора.

CharacterSetName -> (строка)

Набор символов базы данных арендатора.

NcharCharacterSetName -> (строка)

Имя набора символов NCHAR базы данных арендатора.

DeletionProtection -> (булево)

Указывает, включена ли защита от удаления для экземпляра БД.

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

Информация о текущих изменениях для базы данных арендатора.

MasterUserPassword -> (строка)

Пароль пользователя владельца базы данных арендатора.

TenantDBName -> (строка)

Имя базы данных арендатора.

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

Содержит секрет, управляемый RDS в Amazon Web Services Secrets Manager для пароля пользователя владельца.

Дополнительную информацию см. в разделе Управление паролями с помощью Amazon Web Services Secrets Manager в Руководстве пользователя Amazon RDS и Управление паролями с помощью Amazon Web Services Secrets Manager в Руководстве пользователя Amazon Aurora.

SecretArn -> (строка)

Идентификатор ресурса Amazon (ARN) секрета.

SecretStatus -> (строка)

Статус секрета.

Возможные значения статуса включают:

  • creating - Секрет создается.
  • active - Секрет доступен для обычного использования и вращения.
  • rotating - Секрет вращается.
  • impaired - Секрет может использоваться для доступа к учетным данным базы данных, но не может вращаться. Секрет может иметь такой статус, например, если права изменены так, что RDS больше не может получить доступ к секрету или ключу KMS для секрета. Когда у секрета такой статус, вы можете исправить условие, которое привело к этому статусу. В качестве альтернативы, измените экземпляр БД, чтобы отключить автоматическое управление учетными данными базы данных, а затем измените экземпляр БД снова, чтобы включить автоматическое управление учетными данными базы данных.

KmsKeyId -> (строка)

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

TagList -> (список)

Список тегов.

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

(структура)

Метаданные, назначенные ресурсу Amazon RDS, представляющие собой пару ключ-значение.

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

Key -> (строка)

Ключ — это обязательное имя тега. Строковое значение может быть от 1 до 128 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Value -> (строка)

Значение — необязательное значение тега. Строковое значение может быть от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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