Spec-Zone.ru › AWS CLI v2

[ aws . kafka ]

list-nodes

Описание

Возвращает список узлов брокера в кластере.

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

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

Синтаксис

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

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

--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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

NextToken -> (строка)

Маркер постраничных результатов. Когда результат операции ListNodes усечен, вызов возвращает NextToken в ответе. Для получения другой порции узлов укажите этот маркер в следующем запросе.

NodeInfoList -> (список)

Список, содержащий объект NodeInfo.

(структура)

Объект информации об узле.

AddedToClusterTime -> (строка)

Время начала.

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

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

AttachedENIId -> (строка)

Прикрепленный эластичный сетевой интерфейс брокера.

BrokerId -> (двойное)

Идентификатор брокера.

ClientSubnet -> (строка)

Подсеть клиента, к которой принадлежит узел брокера.

ClientVpcIpAddress -> (строка)

Виртуальный частный облачный (VPC) адрес клиента.

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

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

ConfigurationArn -> (строка)

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

ConfigurationRevision -> (длинное)

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

KafkaVersion -> (строка)

Версия Apache Kafka.

Endpoints -> (список)

Адреса для доступа к брокеру.

(строка)

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

Объект ControllerNodeInfo.

Endpoints -> (список)

Адреса для доступа к контроллеру.

(строка)

InstanceType -> (строка)

Тип экземпляра.

NodeARN -> (строка)

Amazon Resource Name (ARN) узла.

NodeType -> (строка)

Тип узла.

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

Объект ZookeeperNodeInfo.

AttachedENIId -> (строка)

Прикрепленный эластичный сетевой интерфейс брокера.

ClientVpcIpAddress -> (строка)

Виртуальный частный облачный (VPC) IP-адрес клиента.

Endpoints -> (список)

Адреса для доступа к ZooKeeper.

(строка)

ZookeeperId -> (двойное)

Идентификатор Zookeeper, специфичный для роли.

ZookeeperVersion -> (строка)

Версия Zookeeper.

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

Spec-Zone.ru

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