Spec-Zone.ru › AWS CLI v2

[ aws . kafka ]

list-clusters-v2

Описание

Возвращает список всех кластеров MSK в текущем регионе.

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

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

Синтаксис

  list-clusters-v2
[--cluster-name-filter <value>]
[--cluster-type-filter <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-name-filter (строка)

Укажите префикс имён кластеров, которые вы хотите получить. Сервис отобразит все кластеры, имена которых начинаются с этого префикса.

--cluster-type-filter (строка)

Укажите либо PROVISIONED, либо SERVERLESS.

--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.

Вывод

ClusterInfoList -> (список)

Информация о каждом из кластеров MSK в ответе.

(структура)

Возвращает информацию о кластере.

ActiveOperationArn -> (строка)

Идентификатор Amazon Resource Name (ARN), уникально определяющий операцию кластера.

ClusterType -> (строка)

Тип кластера.

ClusterArn -> (строка)

Идентификатор Amazon Resource Name (ARN), уникально определяющий кластер.

ClusterName -> (строка)

Имя кластера.

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

Время создания кластера.

CurrentVersion -> (строка)

Текущая версия кластера MSK.

State -> (строка)

Состояние кластера. Возможные состояния: ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER и UPDATING.

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

Информация о состоянии кластера Amazon MSK.

Code -> (строка)

Message -> (строка)

Tags -> (словарь)

Теги, прикрепленные к кластеру.

key -> (строка)

value -> (строка)

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

Информация о выделенном кластере.

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

Информация о брокерских узлах.

BrokerAZDistribution -> (строка)

Распределение брокерских узлов по зонам доступности. Этот параметр является необязательным. Если вы его не укажете, Amazon MSK присвоит ему значение DEFAULT. Вы также можете явно установить этот параметр в значение DEFAULT. Другие значения в настоящее время не допускаются.

Amazon MSK равномерно распределяет брокерские узлы по зонам доступности, соответствующим подсетям, которые вы предоставляете при создании кластера.

ClientSubnets -> (список)

Список подсетей для подключения в клиентской виртуальной частной сети (VPC). AWS создает интерфейсы эластичной сети внутри этих подсетей. Клиентские приложения используют интерфейсы эластичной сети для создания и потребления данных. Клиентские подсети не могут занимать зону доступности с идентификатором use1-az3.

(строка)

InstanceType -> (строка)

Тип экземпляров Amazon EC2, используемых для брокерских узлов Apache Kafka. Допускаются следующие типы экземпляров: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge и kafka.m5.24xlarge.

SecurityGroups -> (список)

AWS группы безопасности, которые необходимо связать с интерфейсами эластичной сети, чтобы указать, кто может подключаться и взаимодействовать с кластером Amazon MSK. Если вы не укажете группу безопасности, Amazon MSK использует групповую безопасность по умолчанию, связанную с VPC.

(строка)

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

Содержит информацию о томах хранилища, подключенных к узлам брокерского MSK.

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

Информация о томах EBS.

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

Информация о предоставленной пропускной способности EBS.

Enabled -> (булево)

Включена или нет пропускная способность EBS.

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

Значение пропускной способности томов EBS для диска данных на каждом узле брокерского kafka в МБ в секунду.

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

Размер тома EBS в ГБ для диска данных на каждом брокерском узле.

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

Информация о конфигурации доступа к брокеру.

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

Контроль доступа к общедоступному доступу для брокеров.

Type -> (строка)

Значение DISABLED указывает, что общедоступный доступ отключен. SERVICE_PROVIDED_EIPS указывает, что общедоступный доступ включен.

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

Контроль доступа к подключению VPC для брокеров.

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

Включает всю информацию об аутентификации клиентов для подключения VPC.

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

Подробная информация о типе аутентификации SASL для подключения VPC.

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

Подробная информация об аутентификации клиента SASL/SCRAM для подключения VPC.

Enabled -> (булево)

Аутентификация SASL/SCRAM включена или выключена для подключения VPC.

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

Подробная информация об аутентификации клиента SASL/IAM для подключения VPC.

Enabled -> (булево)

Аутентификация SASL/IAM включена или выключена для подключения VPC.

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

Подробная информация о типе аутентификации TLS для подключения VPC.

Enabled -> (булево)

Аутентификация TLS включена или выключена для подключения VPC.

ZoneIds -> (список)

Список идентификаторов зон для кластера в виртуальной частной сети (VPC).

(строка)

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

Информация об версии Apache Kafka, развернутой на брокерских узлах.

ConfigurationArn -> (строка)

Amazon Resource Name (ARN) конфигурации, используемой для кластера. Это поле не отображается в этом предварительном выпуске.

ConfigurationRevision -> (длинное целое число)

Ревизия конфигурации для использования. Это поле не отображается в этом предварительном выпуске.

KafkaVersion -> (строка)

Версия Apache Kafka.

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

Включает всю информацию об аутентификации клиента.

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

Подробная информация об аутентификации клиента с использованием SASL.

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

Подробная информация об аутентификации клиента SASL/SCRAM.

Enabled -> (булево)

Аутентификация SASL/SCRAM включена или выключена.

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

Указывает, включен ли контроль доступа IAM.

Enabled -> (булево)

Указывает, включен ли контроль доступа IAM.

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

Подробная информация об аутентификации клиента с использованием TLS.

CertificateAuthorityArnList -> (список)

Список ARN сертификатов центра сертификации ACM.

(строка)

Enabled -> (булево)

Указывает, хотите ли вы включить или отключить аутентификацию TLS.

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

Содержит информацию о трафике без аутентификации в кластер.

Enabled -> (булево)

Указывает, хотите ли вы включить или отключить неаутентифицированный трафик в свой кластер.

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

Включает всю информацию, относящуюся к шифрованию.

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

Подробности шифрования тома данных.

DataVolumeKMSKeyId -> (строка)

ARN ключа AWS KMS для шифрования данных в состоянии покоя. Если вы не укажете ключ KMS, MSK создаст его для вас и будет использовать его.

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

Подробности шифрования в процессе передачи.

ClientBroker -> (строка)

Указывает параметры шифрования данных в процессе передачи между клиентами и брокерами. Допускаются следующие значения:

TLS означает, что общение клиент-брокер включено только с использованием TLS.

TLS_PLAINTEXT означает, что общение клиент-брокер включено как для TLS-шифрованных, так и для данных в формате plain text.

PLAINTEXT означает, что общение клиент-брокер включено только в формате plain text.

Значение по умолчанию — TLS_PLAINTEXT.

InCluster -> (булево)

При установке в значение true, это указывает, что общение между брокерскими узлами кластера зашифровано. При установке в значение false, общение происходит в формате plain text.

Значение по умолчанию — true.

EnhancedMonitoring -> (строка)

Указывает уровень мониторинга для кластера MSK. Возможные значения: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER и PER_TOPIC_PER_PARTITION.

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

Настройки для открытого мониторинга.

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

Настройки Prometheus.

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

Указывает, хотите ли вы включить или отключить JMX Exporter.

EnabledInBroker -> (булево)

Указывает, хотите ли вы включить или отключить JMX Exporter.

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

Указывает, хотите ли вы включить или отключить Node Exporter.

EnabledInBroker -> (булево)

Указывает, хотите ли вы включить или отключить Node Exporter.

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

Информация о доставке логов для кластера.

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

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

Enabled -> (булево)

LogGroup -> (строка)

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

DeliveryStream -> (строка)

Enabled -> (булево)

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

Bucket -> (строка)

Enabled -> (булево)

Prefix -> (строка)

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

Количество брокерских узлов в кластере.

ZookeeperConnectString -> (строка)

Строка подключения для подключения к кластеру Apache ZooKeeper.

ZookeeperConnectStringTls -> (строка)

Строка подключения для подключения к кластеру Apache ZooKeeper по TLS-порту.

StorageMode -> (строка)

Контролирует режим хранения для поддерживаемых уровней хранения.

CustomerActionStatus -> (строка)

Определяет, требуется ли от клиента какое-либо действие.

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

Информация о серверном кластере.

VpcConfigs -> (список)

Конфигурация Amazon VPC для кластера.

(структура)

Конфигурация Amazon VPC для кластера.

SubnetIds -> (список)

Идентификаторы подсетей, связанных с кластером.

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

Включает всю информацию об аутентификации клиента.

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

Подробная информация об аутентификации клиента с использованием SASL.

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

Указывает, включен ли контроль доступа IAM.

Enabled -> (булево)

Указывает, включен ли контроль доступа IAM.

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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