describe-clusters
Описание
Возвращает свойства предоставленных кластеров, включая общие свойства кластера, свойства базы данных кластера, свойства обслуживания и резервного копирования, а также свойства безопасности и доступа. Данная операция поддерживает пагинацию. Дополнительную информацию об управлении кластерами см. в руководстве по управлению кластерами Amazon Redshift в разделе «Кластеры Amazon Redshift».
Если вы укажете и ключи тегов, и значения тегов в одном запросе, Amazon Redshift вернёт все кластеры, соответствующие любому сочетанию указанных ключей и значений. Например, если у вас есть ключи тегов owner и environment, а значения тегов — admin и test, будут возвращены все кластеры, имеющие любое сочетание этих значений.
Если и ключи тегов, и значения тегов опушены из запроса, кластеры будут возвращены независимо от того, есть ли у них ассоциированные ключи или значения тегов.
См. также: Документацию API AWS
describe-clusters — это операция с пагинацией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить пагинацию, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с пагинацией аргумент --query должен извлекать данные из результатов следующих выражений запроса: Clusters
Синтаксис
describe-clusters
[--cluster-identifier <value>]
[--tag-keys <value>]
[--tag-values <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]
Параметры
--cluster-identifier (строка)
Уникальный идентификатор кластера, свойства которого вы запрашиваете. Этот параметр чувствителен к регистру.
По умолчанию возвращаются все кластеры, определённые для учётной записи.
--tag-keys (список)
Ключ или ключи тегов, для которых вы хотите вернуть все соответствующие кластеры, связанные с указанным ключом или ключами. Например, предположим, что у вас есть кластеры, помеченные ключами owner и environment. Если вы укажете оба этих ключа тегов в запросе, Amazon Redshift вернёт ответ с кластерами, у которых есть либо один, либо оба этих ключа тегов.
(строка)
Синтаксис:
"string" "string" ...
--tag-values (список)
Значение или значения тегов, для которых вы хотите вернуть все соответствующие кластеры, связанные с указанным значением или значениями тегов. Например, предположим, что у вас есть кластеры, помеченные значениями admin и test. Если вы укажете оба этих значения тегов в запросе, Amazon Redshift вернёт ответ с кластерами, у которых есть либо одно, либо оба этих значения тегов.
(строка)
Синтаксис:
"string" "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 (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 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.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.
Получение описания всех кластеров
В этом примере возвращается описание всех кластеров для учётной записи. По умолчанию вывод находится в формате JSON.
Команда:
aws redshift describe-clusters
Результат:
{
"Clusters": [
{
"NodeType": "dw.hs1.xlarge",
"Endpoint": {
"Port": 5439,
"Address": "mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com"
},
"ClusterVersion": "1.0",
"PubliclyAccessible": "true",
"MasterUsername": "adminuser",
"ClusterParameterGroups": [
{
"ParameterApplyStatus": "in-sync",
"ParameterGroupName": "default.redshift-1.0"
} ],
"ClusterSecurityGroups": [
{
"Status": "active",
"ClusterSecurityGroupName": "default"
} ],
"AllowVersionUpgrade": true,
"VpcSecurityGroups": \[],
"AvailabilityZone": "us-east-1a",
"ClusterCreateTime": "2013-01-22T21:59:29.559Z",
"PreferredMaintenanceWindow": "sat:03:30-sat:04:00",
"AutomatedSnapshotRetentionPeriod": 1,
"ClusterStatus": "available",
"ClusterIdentifier": "mycluster",
"DBName": "dev",
"NumberOfNodes": 2,
"PendingModifiedValues": {}
} ],
"ResponseMetadata": {
"RequestId": "65b71cac-64df-11e2-8f5b-e90bd6c77476"
}
}
Вы также можете получить ту же информацию в текстовом формате, используя параметр --output text.
Команда:
aws redshift describe-clusters --output text
Результат:
dw.hs1.xlarge 1.0 true adminuser True us-east-1a 2013-01-22T21:59:29.559Z sat:03:30-sat:04:00 1 available mycluster dev 2
ENDPOINT 5439 mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com
in-sync default.redshift-1.0
active default
PENDINGMODIFIEDVALUES
RESPONSEMETADATA 934281a8-64df-11e2-b07c-f7fbdd006c67
Вывод
Маркер -> (строка)
Marker и повторив команду. Если поле Marker пусто, все записи ответа были получены для запроса.Кластеры -> (список)
Список объектов Cluster, где каждый объект описывает один кластер.
(структура)
Описание кластера.
ИдентификаторКластера -> (строка)
ТипУзла -> (строка)
СтатусКластера -> (строка)
Текущее состояние кластера. Возможные значения:
availableavailable, prep-for-resizeavailable, resize-cleanupcancelling-resizecreatingdeletingfinal-snapshothardware-failureincompatible-hsmincompatible-networkincompatible-parametersincompatible-restoremodifyingpausedrebootingrenamingresizingrotating-keysstorage-fullupdating-hsm
СтатусДоступностиКластера -> (строка)
Статус доступности кластера для запросов. Возможные значения:
- Доступен - Кластер доступен для запросов.
- Недоступен - Кластер недоступен для запросов.
- ТехническоеОбслуживание - Кластер периодически доступен для запросов из-за работ по техническому обслуживанию.
- Изменение - Кластер периодически доступен для запросов из-за изменений, которые изменяют кластер.
- Неудачно - Кластер потерпел неудачу и недоступен для запросов.
СтатусИзменения -> (строка)
ИмяАдминистративногоПользователя -> (строка)
ИмяБД -> (строка)
dev dev.КонечнаяТочка -> (структура)
Конечная точка подключения.
Адрес -> (строка)
Порт -> (целое число)
VpcКонечныеТочки -> (список)
Описание конечной точки подключения.
(структура)
Конечная точка подключения для подключения к кластеру Amazon Redshift через прокси.
ИдентификаторVpcКонечнойТочки -> (строка)
ИдентификаторVpc -> (строка)
СетевыеИнтерфейсы -> (список)
Один или несколько сетевых интерфейсов конечной точки. Также известен как интерфейсная конечная точка.
(структура)
Описание сетевого интерфейса.
ИдентификаторСетевогоИнтерфейса -> (строка)
ИдентификаторПодсети -> (строка)
ПриватныйIpАдрес -> (строка)
ЗонаДоступности -> (строка)
Ipv6Адрес -> (строка)
ВремяСозданияКластера -> (временная метка)
АвтоматическийПериодУдержанияСнапшота -> (целое число)
ПериодУдержанияСнапшота -> (целое число)
Установленное по умолчанию количество дней хранения ручного снимка. Если значение равно -1, снимок хранится неограниченно. Это значение не влияет на срок хранения существующих снимков.
Значение должно быть либо -1, либо целым числом от 1 до 3653.
БезопасностиКластераГруппы -> (список)
Список групп безопасности кластера, связанных с кластером. Каждая группа безопасности представлена элементом, содержащим подэлементы ClusterSecurityGroup.Name и ClusterSecurityGroup.Status.
Группы безопасности кластера используются, когда кластер не создается в Amazon Virtual Private Cloud (VPC). Кластеры, созданные в VPC, используют группы безопасности VPC, которые перечисляются параметром VpcSecurityGroups.
(структура)
Описание группы безопасности кластера.
ИмяГруппыБезопасностиКластера -> (строка)
Статус -> (строка)
VpcГруппыБезопасности -> (список)
Список групп безопасности Amazon Virtual Private Cloud (Amazon VPC), связанных с кластером. Этот параметр возвращается только в том случае, если кластер находится в VPC.
(структура)
Описание членов группы безопасности VPC.
ИдентификаторVpcГруппыБезопасности -> (строка)
Статус -> (строка)
ПараметрыКластераГруппы -> (список)
Список групп параметров кластера, связанных с этим кластером. Каждая группа параметров в списке возвращается со своим статусом.
(структура)
Описание статуса группы параметров.
ИмяГруппыПараметров -> (строка)
СтатусПрименениеПараметров -> (строка)
СписокСтатусовПараметровКластера -> (список)
Список статусов параметров.
Дополнительную информацию о параметрах и группах параметров см. в разделе Amazon Redshift Parameter Groups в руководстве Amazon Redshift Cluster Management Guide.
(структура)
Описание статуса группы параметров.
ИмяПараметра -> (строка)
СтатусПрименениеПараметра -> (строка)
Статус параметра, указывающий, синхронизировано ли значение параметра с базой данных, ожидает ли перезагрузки кластера или столкнулся ли с ошибкой при применении.
Вот возможные статусы и их описания.
-
in-sync: Значение параметра синхронизировано с базой данных. -
pending-reboot: Значение параметра будет применено после перезагрузки кластера. -
applying: Значение параметра применяется к базе данных. -
invalid-parameter: Невозможно применить значение параметра, поскольку оно имеет недопустимое значение или синтаксис. -
apply-deferred: Параметр содержит статические изменения свойств. Изменения отложены до перезагрузки кластера. -
apply-error: Невозможно подключиться к кластеру. Изменение параметра будет применено после перезагрузки кластера. -
unknown-error: Невозможно применить изменение параметра прямо сейчас. Изменение будет применено после перезагрузки кластера.
ОписаниеОшибкиПримененияПараметра -> (строка)
ИмяПодсетиКластераГруппы -> (строка)
ИдентификаторVpc -> (строка)
ЗонаДоступности -> (строка)
ПредпочтительныйОкноТехническогоОбслуживания -> (строка)
ОжидаемыеИзменённыеЗначения -> (структура)
Значение, которое, если присутствует, указывает на ожидаемые изменения кластера. Конкретные ожидаемые изменения идентифицируются подэлементами.
ПарольАдминистративногоПользователя -> (строка)
ТипУзла -> (строка)
КоличествоУзлов -> (целое число)
ТипКластера -> (строка)
ВерсияКластера -> (строка)
АвтоматическийПериодУдержанияСнапшота -> (целое число)
ИдентификаторКластера -> (строка)
ДоступныйДляОбщедоступнойСети -> (булево)
РасширенноеМаршрутизированиеVpc -> (булево)
Параметр, определяющий, создается ли кластер с включенным расширенным маршрутизацией VPC. Для создания кластера с использованием расширенного маршрутизирования VPC кластер должен находиться в VPC. Дополнительную информацию см. в разделе Расширенное маршрутизирование VPC в руководстве Amazon Redshift Cluster Management Guide.
Если этот параметр равен true, расширенное маршрутизирование VPC включено.
По умолчанию: false
ИмяТрэкаТехническогоОбслуживания -> (строка)
ТипШифрования -> (строка)
ВерсияКластера -> (строка)
РазрешитьОбновлениеВерсии -> (булево)
true, указывает на то, что автоматические обновления основной версии будут применяться к кластеру во время окна технического обслуживания.КоличествоУзлов -> (целое число)
ДоступныйДляОбщедоступнойСети -> (булево)
Булево значение, которое, если true, указывает, что к кластеру можно получить доступ из общедоступной сети.
По умолчанию: false
Зашифровано -> (булево)
true, указывает, что данные в кластере зашифрованы при хранении.СтатусВосстановления -> (структура)
Значение, описывающее состояние действия восстановления кластера. Этот параметр возвращает null, если кластер не был создан путём восстановления моментального снимка.
Status -> (строка)
CurrentRestoreRateInMegaBytesPerSecond -> (двойное)
SnapshotSizeInMegaBytes -> (длинное целое число)
ProgressInMegaBytes -> (длинное целое число)
ElapsedTimeInSeconds -> (длинное целое число)
EstimatedTimeToCompletionInSeconds -> (длинное целое число)
DataTransferProgress -> (структура)
Status -> (строка)
transferringdata.CurrentRateInMegaBytesPerSecond -> (двойное)
TotalDataInMegaBytes -> (длинное целое число)
DataTransferredInMegaBytes -> (длинное целое число)
EstimatedTimeToCompletionInSeconds -> (длинное целое число)
ElapsedTimeInSeconds -> (длинное целое число)
HsmStatus -> (структура)
Значение, которое сообщает, завершил ли Amazon Redshift кластер применение любых изменений настроек модуля аппаратной защиты (HSM), указанных в команде модификации кластера.
Значения: active, applying
HsmClientCertificateIdentifier -> (строка)
HsmConfigurationIdentifier -> (строка)
Status -> (строка)
Сообщает, завершил ли Amazon Redshift кластер применение любых изменений настроек HSM, указанных в команде модификации кластера.
Значения: active, applying
ClusterSnapshotCopyStatus -> (структура)
Значение, возвращающее целевой регион и период хранения, настроенные для копирования моментальных снимков в другой регион.
DestinationRegion -> (строка)
RetentionPeriod -> (длинное целое число)
ManualSnapshotRetentionPeriod -> (целое число)
Количество дней, в течение которых автоматические моментальные снимки хранятся в целевом регионе после копирования из исходного региона. Если значение равно -1, ручной моментальный снимок хранится неопределённо долго.
Значение должно быть либо -1, либо целым числом от 1 до 3653.
SnapshotCopyGrantName -> (строка)
ClusterPublicKey -> (строка)
ClusterNodes -> (список)
Узлы в кластере.
(структура)
Идентификатор узла в кластере.
NodeRole -> (строка)
PrivateIPAddress -> (строка)
PublicIPAddress -> (строка)
ElasticIpStatus -> (структура)
Состояние адрес elastic IP (EIP).
ElasticIp -> (строка)
Status -> (строка)
ClusterRevisionNumber -> (строка)
Tags -> (список)
Список тегов для кластера.
(структура)
Тег, состоящий из пары имя/значение для ресурса.
Key -> (строка)
Value -> (строка)
KmsKeyId -> (строка)
EnhancedVpcRouting -> (булево)
Вариант, определяющий, нужно ли создавать кластер с включённым улучшенным маршрутизацией VPC. Для создания кластера, использующего улучшенную маршрутизацию VPC, кластер должен находиться в VPC. Дополнительную информацию см. в разделе Улучшенная маршрутизация VPC в Руководстве по управлению кластерами Amazon Redshift.
Если это true, улучшенная маршрутизация VPC включена.
По умолчанию: false
IamRoles -> (список)
Список ролей Identity and Access Management (IAM), которые могут использоваться кластером для доступа к другим службам Amazon Web Services.
(структура)
Роль Identity and Access Management (IAM), которую может использовать связанный Amazon Redshift кластер для доступа к другим службам Amazon Web Services.
IamRoleArn -> (строка)
arn:aws:iam::123456789012:role/RedshiftCopyUnload.ApplyStatus -> (строка)
Значение, описывающее состояние ассоциации роли IAM с Amazon Redshift кластером.
Возможные состояния и описания:
-
in-sync: Роль доступна для использования кластером. -
adding: Роль находится в процессе ассоциации с кластером. -
removing: Роль находится в процессе отсоединения от кластера.
PendingActions -> (список)
Операции кластера, ожидающие запуска.
(строка)
MaintenanceTrackName -> (строка)
ElasticResizeNumberOfNodeOptions -> (строка)
DeferredMaintenanceWindows -> (список)
Описание группы DeferredMaintenanceWindow объектов.
(структура)
Описание отложенного окна технического обслуживания
DeferMaintenanceIdentifier -> (строка)
DeferMaintenanceStartTime -> (метка времени)
DeferMaintenanceEndTime -> (метка времени)
SnapshotScheduleIdentifier -> (строка)
SnapshotScheduleState -> (строка)
ExpectedNextSnapshotScheduleTime -> (метка времени)
ExpectedNextSnapshotScheduleTimeStatus -> (строка)
Состояние ожидаемого следующего моментального снимка для кластеров, имеющих действующее расписание моментальных снимков и включённые резервные копии. Возможные значения:
- OnTrack - Следующий моментальный снимок ожидается в срок.
- Pending - Следующий моментальный снимок ожидает создания.
NextMaintenanceWindowStartTime -> (метка времени)
ResizeInfo -> (структура)
Возвращает следующее:
- AllowCancelResize: булево значение, указывающее, можно ли отменить операцию изменения размера.
- ResizeType: Возвращает ClassicResize
ResizeType -> (строка)
ClassicResize.AllowCancelResize -> (булево)
AvailabilityZoneRelocationStatus -> (строка)
ClusterNamespaceArn -> (строка)
TotalStorageCapacityInMegaBytes -> (длинное целое число)
AquaConfiguration -> (структура)
Это поле устарело. Amazon Redshift автоматически определяет, использовать ли AQUA (Advanced Query Accelerator).
AquaStatus -> (строка)
AquaConfigurationStatus -> (строка)
DefaultIamRoleArn -> (строка)
ReservedNodeExchangeStatus -> (структура)
Состояние запроса обмена резервными узлами. Состояния включают в себя в процессе и запрошено.
ReservedNodeExchangeRequestId -> (строка)
Status -> (строка)
RequestTime -> (метка времени)
SourceReservedNodeId -> (строка)
SourceReservedNodeType -> (строка)
SourceReservedNodeCount -> (целое число)
TargetReservedNodeOfferingId -> (строка)
TargetReservedNodeType -> (строка)
TargetReservedNodeCount -> (целое число)
CustomDomainName -> (строка)
CustomDomainCertificateArn -> (строка)
CustomDomainCertificateExpiryDate -> (метка времени)
MasterPasswordSecretArn -> (string)
MasterPasswordSecretKmsKeyId -> (string)
IpAddressType -> (string)
ipv4 и dualstack.MultiAZ -> (string)
MultiAZSecondary -> (structure)
Вторичный вычислительный узел кластера, если включено многозонное развертывание (Multi-AZ).
AvailabilityZone -> (string)
ClusterNodes -> (list)
Узлы во вторичном вычислительном узле.
(structure)
Идентификатор узла в кластере.
NodeRole -> (string)
PrivateIPAddress -> (string)
PublicIPAddress -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.