describe-db-clusters
Описание
Возвращает информацию о предоставленных кластерах баз данных и поддерживает постраничную навигацию.
Примечание
Данная операция также может возвращать информацию о кластерах Amazon RDS и кластерах Amazon DocDB.См. также: Документация API AWS
describe-db-clusters является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную навигацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной навигацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DBClusters
Синтаксис
describe-db-clusters
[--db-cluster-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-cluster-identifier (строка)
Указанный пользователем идентификатор кластера базы данных. Если этот параметр указан, возвращается информация только о конкретном кластере базы данных. Этот параметр не чувствителен к регистру.
Ограничения:
- Если указан, должен соответствовать существующему DBClusterIdentifier.
--filters (список)
Фильтр, который указывает один или несколько кластеров баз данных для описания.
Поддерживаемые фильтры:
-
db-cluster-id- Принимает идентификаторы кластеров баз данных и имена ресурсов Amazon (ARN) кластеров баз данных. Список результатов будет содержать информацию только о кластерах баз данных, идентифицированных этими ARNs. -
engine- Принимает имя движка (например,neptune) и ограничивает список результатов кластерами баз данных, созданными этим движком.
Например, чтобы вызвать этот API из командной строки Amazon и отфильтровать результаты, чтобы возвращались только кластеры баз данных 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.
--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
- текст
- таблица
- 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-auto-prompt (булево)
Автоматически запрашивать входные параметры CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы входных параметров CLI.
Вывод
Маркер -> (строка)
DBClusters -> (список)
Содержит список кластеров баз данных для пользователя.
(структура)
Содержит сведения о кластере Amazon Neptune баз данных.
Этот тип данных используется в качестве элемента ответа в операции DescribeDBClusters.
AllocatedStorage -> (целое число)
AllocatedStorage всегда возвращает 1, потому что размер хранилища кластера баз данных Neptune не фиксирован, а автоматически корректируется по мере необходимости.AvailabilityZones -> (список)
Предоставляет список зон доступности EC2, в которых могут создаваться экземпляры в кластере баз данных.
(строка)
BackupRetentionPeriod -> (целое число)
CharacterSetName -> (строка)
DatabaseName -> (строка)
DBClusterIdentifier -> (строка)
DBClusterParameterGroup -> (строка)
DBSubnetGroup -> (строка)
Status -> (строка)
PercentProgress -> (строка)
EarliestRestorableTime -> (метка времени)
Endpoint -> (строка)
ReaderEndpoint -> (строка)
Конечная точка чтения для кластера баз данных. Конечная точка чтения для кластера баз данных балансирует подключения через доступные реплики чтения в кластере баз данных. По мере запроса клиентами новых подключений к конечной точке чтения Neptune распределяет запросы подключений между репликами чтения в кластере баз данных. Эта функция может помочь сбалансировать вашу рабочую нагрузку чтения между несколькими репликами чтения в вашем кластере баз данных.
Если происходит переключение, и реплика чтения, к которой вы подключены, становится основным экземпляром, ваше подключение прерывается. Чтобы продолжить отправку рабочей нагрузки чтения другим репликам чтения в кластере, вы можете повторно подключиться к конечной точке чтения.
MultiAZ -> (булево)
Engine -> (строка)
EngineVersion -> (строка)
LatestRestorableTime -> (метка времени)
Port -> (целое число)
MasterUsername -> (строка)
DBClusterOptionGroupMemberships -> (список)
Не поддерживается Neptune.
(структура)
Не поддерживается Neptune.
DBClusterOptionGroupName -> (строка)
Status -> (строка)
PreferredBackupWindow -> (строка)
BackupRetentionPeriod .PreferredMaintenanceWindow -> (строка)
ReplicationSourceIdentifier -> (строка)
ReadReplicaIdentifiers -> (список)
Содержит один или несколько идентификаторов реплик чтения, связанных с этим кластером баз данных.
(строка)
DBClusterMembers -> (список)
Предоставляет список экземпляров, составляющих кластер баз данных.
(структура)
Содержит информацию об экземпляре, являющемся частью кластера баз данных.
DBInstanceIdentifier -> (строка)
IsClusterWriter -> (булево)
true, если член кластера является основным экземпляром для кластера баз данных, и false в противном случае.DBClusterParameterGroupStatus -> (строка)
PromotionTier -> (целое число)
VpcSecurityGroups -> (список)
Предоставляет список групп безопасности VPC, к которым принадлежит кластер баз данных.
(структура)
Этот тип данных используется в качестве элемента ответа для запросов о членстве в группе безопасности VPC.
VpcSecurityGroupId -> (строка)
Status -> (строка)
HostedZoneId -> (строка)
StorageEncrypted -> (булево)
KmsKeyId -> (строка)
StorageEncrypted равно true, то идентификатор ключа Amazon KMS для зашифрованного кластера баз данных.DbClusterResourceId -> (строка)
DBClusterArn -> (строка)
AssociatedRoles -> (список)
Предоставляет список ролей управления доступом и идентификацией (IAM) Amazon, связанных с кластером баз данных. Роли IAM, связанные с кластером баз данных, предоставляют разрешения для доступа кластера баз данных к другим службам Amazon от вашего имени.
(структура)
Описывает роль управления доступом и идентификацией (IAM) Amazon, связанную с кластером баз данных.
RoleArn -> (строка)
Status -> (строка)
Описывает состояние связи между ролью IAM и кластером баз данных. Свойство Status возвращает одно из следующих значений:
-
ACTIVE— ARN роли IAM связан с кластером баз данных и может использоваться для доступа к другим службам Amazon от вашего имени. -
PENDING— ARN роли IAM связывается с кластером баз данных. -
INVALID— ARN роли IAM связан с кластером баз данных, но кластер баз данных не может принять роль IAM для доступа к другим службам Amazon от вашего имени.
FeatureName -> (строка)
IAMDatabaseAuthenticationEnabled -> (булево)
CloneGroupId -> (строка)
ClusterCreateTime -> (метка времени)
CopyTagsToSnapshot -> (булево)
EnabledCloudwatchLogsExports -> (список)
Список типов журналов, которые этот кластер баз данных настроен на экспорт в CloudWatch Logs. Допустимые типы журналов: audit (для публикации аудиторских журналов в CloudWatch) и slowquery (для публикации журналов медленных запросов в CloudWatch). См. Публикация журналов Neptune в Amazon CloudWatch Logs.
(строка)
PendingModifiedValues -> (структура)
Этот тип данных используется в качестве элемента ответа в операции ModifyDBCluster и содержит изменения, которые будут применены во время следующего окна технического обслуживания.
PendingCloudwatchLogsExports -> (структура)
Эта PendingCloudwatchLogsExports структура указывает ожидаемые изменения в том, какие журналы CloudWatch включены и какие выключены.
LogTypesToEnable -> (список)
Типы журналов, которые в процессе отключения. После отключения эти типы журналов не экспортируются в CloudWatch Logs.
(строка)
LogTypesToDisable -> (список)
Типы журналов, которые в процессе включения. После включения эти типы журналов экспортируются в CloudWatch Logs.
(строка)
DBClusterIdentifier -> (строка)
IAMDatabaseAuthenticationEnabled -> (булево)
EngineVersion -> (строка)
BackupRetentionPeriod -> (целое число)
StorageType -> (строка)
Ожидаемое изменение типа хранилища для кластера баз данных. Допустимые значения:
-
**
standard** – ( по умолчанию ) Настраивает экономичное хранилище базы данных для приложений с умеренным или небольшим объемом операций ввода-вывода. -
**
iopt1** – Включает хранилище с оптимизацией под ввод-вывод, которое предназначено для удовлетворения потребностей высоконагруженных рабочих нагрузок графов, которые требуют прогнозируемой стоимости с низкой задержкой операций ввода-вывода и постоянной пропускной способностью операций ввода-вывода. Хранилище Neptune с оптимизацией под ввод-вывод доступно только начиная с версии движка 1.3.0.0.
AllocatedStorage -> (целое число)
AllocatedStorage всегда возвращает 1, так как размер хранилища кластера баз данных Neptune не фиксирован, а автоматически корректируется по мере необходимости.Iops -> (целое число)
DeletionProtection -> (булево)
CrossAccountClone -> (булево)
true , кластер баз данных может быть клонирован в другие учетные записи.AutomaticRestartTime -> (метка времени)
ServerlessV2ScalingConfiguration -> (структура)
Отображает конфигурацию масштабирования для кластера базы данных Neptune Serverless.
Дополнительную информацию см. в разделе Использование Amazon Neptune Serverless в Руководстве пользователя Amazon Neptune.
MinCapacity -> (double)
MaxCapacity -> (double)
GlobalClusterIdentifier -> (string)
IOOptimizedNextAllowedModificationTime -> (timestamp)
iopt1.StorageType -> (string)
Тип хранения, используемый кластером базы данных.
Допустимые значения:
-
**
standard** – (по умолчанию) Обеспечивает экономичное хранение базы данных для приложений с умеренным или небольшим использованием операций ввода-вывода. -
**
iopt1** – Включает оптимизированное хранение ввода-вывода, предназначенное для удовлетворения потребностей ресурсоемких графических рабочих нагрузок, которые требуют предсказуемой стоимости с низкой задержкой ввода-вывода и постоянной пропускной способностью ввода-вывода. Оптимизированное хранение ввода-вывода Neptune доступно только начиная с выпуска движка 1.3.0.0.
© Copyright 2025, Amazon Web Services. Created using Sphinx.