describe-db-instances
Описание
Возвращает информацию о предоставленных экземплярах и поддерживает постраничную навигацию.
Примечание
Данная операция также может возвращать информацию об экземплярах Amazon RDS и экземплярах Amazon DocDB.См. также: Документация API AWS
describe-db-instances является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную навигацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной навигацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DBInstances
Синтаксис
describe-db-instances
[--db-instance-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-instance-identifier (строка)
Указанный пользователем идентификатор экземпляра. Если этот параметр указан, возвращается информация только об определенном экземпляре базы данных. Этот параметр не чувствителен к регистру.
Ограничения:
- Если указан, должен соответствовать идентификатору существующего DBInstance.
--filters (список)
Фильтр, который определяет один или несколько экземпляров баз данных для описания.
Поддерживаемые фильтры:
-
db-cluster-id- Принимает идентификаторы кластеров баз данных и Amazon Resource Names (ARN) кластеров баз данных. Список результатов будет содержать только информацию об экземплярах баз данных, связанных с кластерами баз данных, определенными этими ARN. -
engine- Принимает имя движка (например,neptune) и ограничивает список результатов экземплярами баз данных, созданными этим движком.
Например, для вызова этого API из командной строки Amazon CLI и фильтрации таким образом, чтобы возвращались только экземпляры баз данных Neptune, можно использовать следующую команду:
(структура)
Этот тип в настоящее время не поддерживается.
Имя -> (строка)
Значения -> (список)
Этот параметр в настоящее время не поддерживается.
(строка)
Сокращённый синтаксис:
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 (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-auto-prompt (булево)
Автоматически запросить параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматический запрос параметров входных данных CLI.
Вывод
Маркер -> (строка)
MaxRecords.DBInstances -> (список)
Список экземпляров DBInstance.
(структура)
Содержит данные об экземпляре Amazon Neptune DB.
Этот тип данных используется в качестве элемента ответа в действии DescribeDBInstances.
DBInstanceIdentifier -> (строка)
DBInstanceClass -> (строка)
Engine -> (строка)
DBInstanceStatus -> (строка)
MasterUsername -> (строка)
DBName -> (строка)
Endpoint -> (структура)
Указывает конечную точку подключения.
Address -> (строка)
Port -> (целое число)
HostedZoneId -> (строка)
AllocatedStorage -> (целое число)
InstanceCreateTime -> (метка времени)
PreferredBackupWindow -> (строка)
BackupRetentionPeriod.BackupRetentionPeriod -> (целое число)
DBSecurityGroups -> (список)
Предоставляет список элементов группы безопасности DB, содержащих только DBSecurityGroup.Name и DBSecurityGroup.Status подэлементы.
(структура)
Указывает членство в выделенной группе безопасности DB.
DBSecurityGroupName -> (строка)
Status -> (строка)
VpcSecurityGroups -> (список)
Предоставляет список элементов групп безопасности VPC, к которым принадлежит экземпляр DB.
(структура)
Этот тип данных используется в качестве элемента ответа для запросов о членстве в группе безопасности VPC.
VpcSecurityGroupId -> (строка)
Status -> (строка)
DBParameterGroups -> (список)
Предоставляет список групп параметров DB, применённых к этому экземпляру DB.
(структура)
Состояние группы параметров DB.
Этот тип данных используется в качестве элемента ответа в следующих действиях:
- CreateDBInstance
- DeleteDBInstance
- ModifyDBInstance
- RebootDBInstance
DBParameterGroupName -> (строка)
ParameterApplyStatus -> (строка)
AvailabilityZone -> (строка)
DBSubnetGroup -> (структура)
Указывает информацию о группе подсетей, связанной с экземпляром DB, включая имя, описание и подсети в группе подсетей.
DBSubnetGroupName -> (строка)
DBSubnetGroupDescription -> (строка)
VpcId -> (строка)
SubnetGroupStatus -> (строка)
Subnets -> (список)
Содержит список элементов Subnet.
(структура)
Указывает подсеть.
Этот тип данных используется в качестве элемента ответа в действии DescribeDBSubnetGroups.
SubnetIdentifier -> (строка)
SubnetAvailabilityZone -> (структура)
Указывает зону доступности EC2, в которой находится подсеть.
Name -> (строка)
SubnetStatus -> (строка)
DBSubnetGroupArn -> (строка)
PreferredMaintenanceWindow -> (строка)
PendingModifiedValues -> (структура)
Указывает, что изменения в экземпляре DB ожидаются. Этот элемент включается только при наличии ожидаемых изменений. Конкретные изменения идентифицируются подэлементами.
DBInstanceClass -> (строка)
DBInstanceClass для экземпляра DB, которое будет применено или в настоящее время применяется.AllocatedStorage -> (целое число)
AllocatedStorage для экземпляра DB, который будет применён или в настоящее время применяется.MasterUserPassword -> (строка)
Port -> (целое число)
BackupRetentionPeriod -> (целое число)
MultiAZ -> (булево)
EngineVersion -> (строка)
LicenseModel -> (строка)
Iops -> (целое число)
DBInstanceIdentifier -> (строка)
DBInstanceIdentifier для экземпляра DB, которое будет применено или в настоящее время применяется.StorageType -> (строка)
CACertificateIdentifier -> (строка)
DBSubnetGroupName -> (строка)
PendingCloudwatchLogsExports -> (структура)
Эта структура PendingCloudwatchLogsExports указывает ожидаемые изменения, для которых включены и отключены журналы CloudWatch.
LogTypesToEnable -> (список)
Типы журналов, которые находятся в процессе отключения. После отключения эти типы журналов не экспортируются в CloudWatch Logs.
(строка)
LogTypesToDisable -> (список)
Типы журналов, которые находятся в процессе включения. После включения эти типы журналов экспортируются в CloudWatch Logs.
(строка)
LatestRestorableTime -> (метка времени)
MultiAZ -> (булево)
EngineVersion -> (строка)
AutoMinorVersionUpgrade -> (булево)
ReadReplicaSourceDBInstanceIdentifier -> (строка)
ReadReplicaDBInstanceIdentifiers -> (список)
Содержит один или несколько идентификаторов реплик чтения, связанных с этим экземпляром DB.
(строка)
ReadReplicaDBClusterIdentifiers -> (список)
Содержит один или несколько идентификаторов кластеров DB, которые являются репликами чтения этого экземпляра DB.
(строка)
LicenseModel -> (строка)
Iops -> (целое число)
OptionGroupMemberships -> (список)
(структура)
Не поддерживается Neptune.
OptionGroupName -> (строка)
Status -> (строка)
CharacterSetName -> (строка)
SecondaryAvailabilityZone -> (строка)
PubliclyAccessible -> (булево)
StatusInfos -> (список)
Состояние реплики чтения. Если экземпляр не является репликой чтения, это пусто.
(структура)
Предоставляет список информации о состоянии экземпляра DB.
StatusType -> (строка)
Normal -> (булево)
Status -> (строка)
Message -> (строка)
StorageType -> (строка)
TdeCredentialArn -> (строка)
DbInstancePort -> (целое число)
DBClusterIdentifier -> (строка)
StorageEncrypted -> (булево)
KmsKeyId -> (строка)
DbiResourceId -> (строка)
CACertificateIdentifier -> (строка)
DomainMemberships -> (список)
Не поддерживается
(структура)
Запись членства в домене Active Directory, связанная с экземпляром DB.
Domain -> (строка)
Status -> (строка)
FQDN -> (строка)
IAMRoleName -> (строка)
CopyTagsToSnapshot -> (булево)
MonitoringInterval -> (целое число)
EnhancedMonitoringResourceArn -> (string)
MonitoringRoleArn -> (string)
PromotionTier -> (integer)
DBInstanceArn -> (string)
Timezone -> (string)
IAMDatabaseAuthenticationEnabled -> (boolean)
PerformanceInsightsEnabled -> (boolean)
PerformanceInsightsKMSKeyId -> (string)
EnabledCloudwatchLogsExports -> (list)
Список типов журналов, которые настроен этот экземпляр базы данных для экспорта в CloudWatch Logs.
(string)
DeletionProtection -> (boolean)
© Copyright 2025, Amazon Web Services. Created using Sphinx.