Spec-Zone.ru › AWS CLI v2

[ aws . нептун ]

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 -> (строка)

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

DBInstanceClass -> (строка)

Содержит имя класса вычислительной и запоминающей емкости экземпляра DB.

Engine -> (строка)

Предоставляет имя движка базы данных, который будет использоваться для данного экземпляра DB.

DBInstanceStatus -> (строка)

Указывает текущее состояние этой базы данных.

MasterUsername -> (строка)

Не поддерживается Neptune.

DBName -> (строка)

Имя базы данных.

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

Указывает конечную точку подключения.

Address -> (строка)

Указывает DNS-адрес экземпляра DB.

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

Указывает порт, на котором работает движок базы данных.

HostedZoneId -> (строка)

Указывает идентификатор, присвоенный Amazon Route 53 при создании хостированной зоны.

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

Не поддерживается Neptune.

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

Предоставляет дату и время создания экземпляра DB.

PreferredBackupWindow -> (строка)

Указывает ежедневный интервал времени, в течение которого создаются автоматические резервные копии, если автоматические резервные копии включены, как определено BackupRetentionPeriod.

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

Указывает количество дней, в течение которых сохраняются автоматические снимки базы данных.

DBSecurityGroups -> (список)

Предоставляет список элементов группы безопасности DB, содержащих только DBSecurityGroup.Name и DBSecurityGroup.Status подэлементы.

(структура)

Указывает членство в выделенной группе безопасности DB.

DBSecurityGroupName -> (строка)

Имя группы безопасности DB.

Status -> (строка)

Состояние группы безопасности DB.

VpcSecurityGroups -> (список)

Предоставляет список элементов групп безопасности VPC, к которым принадлежит экземпляр DB.

(структура)

Этот тип данных используется в качестве элемента ответа для запросов о членстве в группе безопасности VPC.

VpcSecurityGroupId -> (строка)

Имя группы безопасности VPC.

Status -> (строка)

Состояние группы безопасности VPC.

DBParameterGroups -> (список)

Предоставляет список групп параметров DB, применённых к этому экземпляру DB.

(структура)

Состояние группы параметров DB.

Этот тип данных используется в качестве элемента ответа в следующих действиях:

  • CreateDBInstance
  • DeleteDBInstance
  • ModifyDBInstance
  • RebootDBInstance

DBParameterGroupName -> (строка)

Имя группы параметров DP.

ParameterApplyStatus -> (строка)

Состояние обновлений параметров.

AvailabilityZone -> (строка)

Указывает имя зоны доступности, в которой находится экземпляр DB.

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

Указывает информацию о группе подсетей, связанной с экземпляром DB, включая имя, описание и подсети в группе подсетей.

DBSubnetGroupName -> (строка)

Имя группы подсетей DB.

DBSubnetGroupDescription -> (строка)

Предоставляет описание группы подсетей DB.

VpcId -> (строка)

Предоставляет VpcId группы подсетей DB.

SubnetGroupStatus -> (строка)

Предоставляет состояние группы подсетей DB.

Subnets -> (список)

Содержит список элементов Subnet.

(структура)

Указывает подсеть.

Этот тип данных используется в качестве элемента ответа в действии DescribeDBSubnetGroups.

SubnetIdentifier -> (строка)

Указывает идентификатор подсети.

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

Указывает зону доступности EC2, в которой находится подсеть.

Name -> (строка)

Имя зоны доступности.

SubnetStatus -> (строка)

Указывает состояние подсети.

DBSubnetGroupArn -> (строка)

Amazon Resource Name (ARN) для группы подсетей DB.

PreferredMaintenanceWindow -> (строка)

Указывает еженедельный интервал времени, в течение которого может происходить техническое обслуживание системы, в формате UTC.

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

Указывает, что изменения в экземпляре DB ожидаются. Этот элемент включается только при наличии ожидаемых изменений. Конкретные изменения идентифицируются подэлементами.

DBInstanceClass -> (строка)

Содержит новое DBInstanceClass для экземпляра DB, которое будет применено или в настоящее время применяется.

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

Содержит новый размер AllocatedStorage для экземпляра DB, который будет применён или в настоящее время применяется.

MasterUserPassword -> (строка)

Не поддерживается Neptune.

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

Указывает ожидаемый порт для экземпляра DB.

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

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

MultiAZ -> (булево)

Указывает, что экземпляр Single-AZ DB должен быть изменён на развертывание Multi-AZ.

EngineVersion -> (строка)

Указывает версию движка базы данных.

LicenseModel -> (строка)

Не поддерживается Neptune.

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

Указывает новое значение Provisioned IOPS для экземпляра DB, которое будет применено или в настоящее время применяется.

DBInstanceIdentifier -> (строка)

Содержит новое DBInstanceIdentifier для экземпляра DB, которое будет применено или в настоящее время применяется.

StorageType -> (строка)

Не применимо. В Neptune тип хранилища управляется на уровне кластера DB.

CACertificateIdentifier -> (строка)

Указывает идентификатор сертификата CA для экземпляра DB.

DBSubnetGroupName -> (строка)

Новая группа подсетей DB для экземпляра DB.

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

Эта структура PendingCloudwatchLogsExports указывает ожидаемые изменения, для которых включены и отключены журналы CloudWatch.

LogTypesToEnable -> (список)

Типы журналов, которые находятся в процессе отключения. После отключения эти типы журналов не экспортируются в CloudWatch Logs.

(строка)

LogTypesToDisable -> (список)

Типы журналов, которые находятся в процессе включения. После включения эти типы журналов экспортируются в CloudWatch Logs.

(строка)

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

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

MultiAZ -> (булево)

Указывает, является ли экземпляр DB развертыванием Multi-AZ.

EngineVersion -> (строка)

Указывает версию движка базы данных.

AutoMinorVersionUpgrade -> (булево)

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

ReadReplicaSourceDBInstanceIdentifier -> (строка)

Содержит идентификатор исходного экземпляра DB, если этот экземпляр DB является репликой чтения.

ReadReplicaDBInstanceIdentifiers -> (список)

Содержит один или несколько идентификаторов реплик чтения, связанных с этим экземпляром DB.

(строка)

ReadReplicaDBClusterIdentifiers -> (список)

Содержит один или несколько идентификаторов кластеров DB, которые являются репликами чтения этого экземпляра DB.

(строка)

LicenseModel -> (строка)

Информация о модели лицензии для данного экземпляра DB.

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

Указывает значение Provisioned IOPS (операций ввода/вывода в секунду).

OptionGroupMemberships -> (список)

(Не поддерживается Neptune)

(структура)

Не поддерживается Neptune.

OptionGroupName -> (строка)

Не поддерживается Neptune.

Status -> (строка)

Не поддерживается Neptune.

CharacterSetName -> (строка)

(Не поддерживается Neptune)

SecondaryAvailabilityZone -> (строка)

При наличии указывает имя вторичной зоны доступности для экземпляра DB с поддержкой Multi-AZ.

PubliclyAccessible -> (булево)

Этот флаг больше не используется.

StatusInfos -> (список)

Состояние реплики чтения. Если экземпляр не является репликой чтения, это пусто.

(структура)

Предоставляет список информации о состоянии экземпляра DB.

StatusType -> (строка)

Это значение в настоящее время «репликация чтения».

Normal -> (булево)

Булевое значение, равное true, если экземпляр работает нормально, или false, если экземпляр находится в состоянии ошибки.

Status -> (строка)

Состояние экземпляра DB. Для StatusType реплики чтения значения могут быть replicating, error, stopped или terminated.

Message -> (строка)

Подробности об ошибке, если для экземпляра есть ошибка. Если экземпляр не находится в состоянии ошибки, это значение пусто.

StorageType -> (строка)

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

TdeCredentialArn -> (строка)

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

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

Указывает порт, на котором слушает экземпляр DB. Если экземпляр DB является частью кластера DB, этот порт может отличаться от порта кластера DB.

DBClusterIdentifier -> (строка)

Если экземпляр DB является членом кластера DB, содержит имя кластера DB, членом которого является экземпляр DB.

StorageEncrypted -> (булево)

Не поддерживается: шифрование экземпляров DB управляется кластером DB.

KmsKeyId -> (строка)

Не поддерживается: шифрование экземпляров DB управляется кластером DB.

DbiResourceId -> (строка)

Уникальный, неизменяемый идентификатор экземпляра DB, специфичный для региона Amazon. Этот идентификатор содержится в журнале Amazon CloudTrail всякий раз, когда к ключу Amazon KMS для экземпляра DB осуществляется доступ.

CACertificateIdentifier -> (строка)

Идентификатор сертификата CA для этого экземпляра DB.

DomainMemberships -> (список)

Не поддерживается

(структура)

Запись членства в домене Active Directory, связанная с экземпляром DB.

Domain -> (строка)

Идентификатор домена Active Directory.

Status -> (строка)

Состояние членства экземпляра DB в домене Active Directory (например, joined, pending-join, failed и т. д.).

FQDN -> (строка)

Полное доменное имя домена Active Directory.

IAMRoleName -> (строка)

Имя роли IAM, используемой при выполнении вызовов API к службе каталогов.

CopyTagsToSnapshot -> (булево)

Указывает, копируются ли теги из экземпляра DB в снимки экземпляра DB.

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

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

EnhancedMonitoringResourceArn -> (string)

Идентификатор ресурса Amazon (ARN) потока журналов Amazon CloudWatch Logs, который получает данные метрик расширенного мониторинга для экземпляра базы данных.

MonitoringRoleArn -> (string)

ARN для роли IAM, которая разрешает Neptune отправлять метрики расширенного мониторинга в Amazon CloudWatch Logs.

PromotionTier -> (integer)

Значение, определяющее порядок, в котором Реплика чтения повышается до основного экземпляра после сбоя существующего основного экземпляра.

DBInstanceArn -> (string)

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

Timezone -> (string)

Не поддерживается.

IAMDatabaseAuthenticationEnabled -> (boolean)

Истинно, если аутентификация Amazon Identity and Access Management (IAM) включена, и ложно в противном случае.

PerformanceInsightsEnabled -> (boolean)

(Не поддерживается Neptune)

PerformanceInsightsKMSKeyId -> (string)

(Не поддерживается Neptune)

EnabledCloudwatchLogsExports -> (list)

Список типов журналов, которые настроен этот экземпляр базы данных для экспорта в CloudWatch Logs.

(string)

DeletionProtection -> (boolean)

Указывает, включена ли защита от удаления для экземпляра базы данных. При включенной защите от удаления экземпляр удалить нельзя. См. Удаление экземпляра базы данных.

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

Spec-Zone.ru

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