list-cluster-operations
Описание
Возвращает список всех операций, выполненных на указанном кластере MSK.
См. также: Документацию API AWS
list-cluster-operations — это постраничная операция. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ClusterOperationInfoList
Синтаксис
list-cluster-operations
--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 (строка)
--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.
Выходные данные
ClusterOperationInfoList -> (список)
Массив объектов информации об операции кластера.
(структура)
Возвращает информацию об операции кластера.
ClientRequestId -> (строка)
ClusterArn -> (строка)
CreationTime -> (метка времени)
EndTime -> (метка времени)
ErrorInfo -> (структура)
Описание ошибки, если операция завершилась неудачно.
ErrorCode -> (строка)
ErrorString -> (строка)
OperationArn -> (строка)
OperationState -> (строка)
OperationSteps -> (список)
Шаги, выполненные во время операции.
(структура)
Шаг, выполненный во время операции кластера.
StepInfo -> (структура)
Информация о шаге и его статусе.
StepStatus -> (строка)
StepName -> (строка)
OperationType -> (строка)
SourceClusterInfo -> (структура)
Информация об атрибутах кластера до обновления кластера.
BrokerEBSVolumeInfo -> (список)
Указывает размер EBS тома и идентификатор связанного брокера.
(структура)
Указывает информацию об обновлении EBS тома. Идентификатор брокера должен быть установлен на ключевое слово ALL. Это означает, что изменения применяются ко всем брокерам в кластере.
KafkaBrokerNodeId -> (строка)
ProvisionedThroughput -> (структура)
Информация о пропускной способности EBS тома.
Enabled -> (логическое)
VolumeThroughput -> (целое число)
VolumeSizeGB -> (целое число)
ConfigurationInfo -> (структура)
Информация о внесённых изменениях в конфигурацию брокеров.
Arn -> (строка)
Revision -> (длинное целое число)
NumberOfBrokerNodes -> (целое число)
EnhancedMonitoring -> (строка)
OpenMonitoring -> (структура)
Настройки для открытого мониторинга.
Prometheus -> (структура)
Настройки Prometheus.
JmxExporter -> (структура)
Указывает, нужно ли включить или отключить JMX Exporter.
EnabledInBroker -> (логическое)
NodeExporter -> (структура)
Указывает, нужно ли включить или отключить Node Exporter.
EnabledInBroker -> (логическое)
KafkaVersion -> (строка)
LoggingInfo -> (структура)
Вы можете настроить кластер MSK таким образом, чтобы он отправлял журналы брокера в различные типы назначений. Это контейнер для конфигурационных деталей, связанных с журналами брокера.
BrokerLogs -> (структура)
CloudWatchLogs -> (структура)
Enabled -> (логическое)
LogGroup -> (строка)
Firehose -> (структура)
DeliveryStream -> (строка)
Enabled -> (логическое)
S3 -> (структура)
Bucket -> (строка)
Enabled -> (логическое)
Prefix -> (строка)
InstanceType -> (строка)
ClientAuthentication -> (структура)
Включает всю информацию об аутентификации клиентов.
Sasl -> (структура)
Подробности для аутентификации клиентов с использованием SASL.
Scram -> (структура)
Подробности для аутентификации клиентов с использованием SASL/SCRAM.
Enabled -> (логическое)
Iam -> (структура)
Указывает, включен ли контроль доступа IAM.
Enabled -> (логическое)
Tls -> (структура)
Подробности для аутентификации клиентов с использованием TLS.
CertificateAuthorityArnList -> (список)
Список ARN центров сертификации ACM.
(строка)
Enabled -> (логическое)
Unauthenticated -> (структура)
Содержит информацию о неаутентифицированном трафике в кластере.
Enabled -> (логическое)
EncryptionInfo -> (структура)
Включает всю информацию, связанную с шифрованием.
EncryptionAtRest -> (структура)
Подробности шифрования данных.
DataVolumeKMSKeyId -> (строка)
EncryptionInTransit -> (структура)
Подробности шифрования в процессе передачи.
ClientBroker -> (строка)
Указывает настройки шифрования данных при передаче между клиентами и брокерами. Возможные значения:
TLS — означает, что общение клиент-брокер включено только с помощью TLS.
TLS_PLAINTEXT — означает, что общение клиент-брокер включено как для данных с шифрованием TLS, так и для данных без шифрования.
PLAINTEXT — означает, что общение клиент-брокер включено только без шифрования.
Значение по умолчанию — TLS_PLAINTEXT.
InCluster -> (логическое)
При значении true указывается, что данные об обмене сообщениями между узлами брокера кластера зашифрованы. При значении false общение происходит без шифрования.
Значение по умолчанию — true.
ConnectivityInfo -> (структура)
Информация о конфигурации доступа к брокеру.
PublicAccess -> (структура)
Контроль доступа к публичным брокерам.
Type -> (строка)
VpcConnectivity -> (структура)
Контроль доступа к VPC для брокеров.
ClientAuthentication -> (структура)
Включает всю информацию об аутентификации клиентов для подключения к VPC.
Sasl -> (структура)
Подробности типа аутентификации SASL для подключения к VPC.
Scram -> (структура)
Подробности для аутентификации клиентов с использованием SASL/SCRAM для подключения к VPC.
Enabled -> (логическое)
Iam -> (структура)
Подробности для аутентификации клиентов с использованием SASL/IAM для подключения к VPC.
Enabled -> (логическое)
Tls -> (структура)
Подробности типа аутентификации TLS для подключения к VPC.
Enabled -> (логическое)
StorageMode -> (строка)
BrokerCountUpdateInfo -> (структура)
Описание брокеров, изменяемых во время обновления количества брокеров.
CreatedBrokerIds -> (список)
Идентификаторы брокеров Kafka, создаваемых в ходе операции.
(вещественное число)
DeletedBrokerIds -> (список)
Идентификаторы брокеров Kafka, удаляемых в ходе операции.
(вещественное число)
TargetClusterInfo -> (структура)
Информация о атрибутах кластера после обновления кластера.
BrokerEBSVolumeInfo -> (список)
Указывает размер тома EBS и идентификатор связанного брокера.
(структура)
Указывает информацию об обновлении тома EBS. Идентификатор брокера должен быть установлен на ключевое слово ALL. Это означает, что изменения применяются ко всем брокерам в кластере.
KafkaBrokerNodeId -> (строка)
ProvisionedThroughput -> (структура)
Информация о пропускной способности тома EBS.
Enabled -> (булево)
VolumeThroughput -> (целое число)
VolumeSizeGB -> (целое число)
ConfigurationInfo -> (структура)
Информация об изменениях в конфигурации брокеров.
Arn -> (строка)
Revision -> (длинное целое число)
NumberOfBrokerNodes -> (целое число)
EnhancedMonitoring -> (строка)
OpenMonitoring -> (структура)
Настройки для открытого мониторинга.
Prometheus -> (структура)
Настройки Prometheus.
JmxExporter -> (структура)
Указывает, хотите ли вы включить или отключить JMX Exporter.
EnabledInBroker -> (булево)
NodeExporter -> (структура)
Указывает, хотите ли вы включить или отключить Node Exporter.
EnabledInBroker -> (булево)
KafkaVersion -> (строка)
LoggingInfo -> (структура)
Вы можете настроить кластер MSK для отправки журналов брокеров в разные типы назначений. Это контейнер для конфигурации, связанной с журналами брокеров.
BrokerLogs -> (структура)
CloudWatchLogs -> (структура)
Enabled -> (булево)
LogGroup -> (строка)
Firehose -> (структура)
DeliveryStream -> (строка)
Enabled -> (булево)
S3 -> (структура)
Bucket -> (строка)
Enabled -> (булево)
Prefix -> (строка)
InstanceType -> (строка)
ClientAuthentication -> (структура)
Включает всю информацию об аутентификации клиентов.
Sasl -> (структура)
Подробности для аутентификации клиента с использованием SASL.
Scram -> (структура)
Подробности для аутентификации клиента SASL/SCRAM.
Enabled -> (булево)
Iam -> (структура)
Указывает, включен ли контроль доступа IAM.
Enabled -> (булево)
Tls -> (структура)
Подробности для аутентификации клиента с использованием TLS.
CertificateAuthorityArnList -> (список)
Список ARN центров сертификации ACM.
(строка)
Enabled -> (булево)
Unauthenticated -> (структура)
Содержит информацию о незащищенном трафике в кластере.
Enabled -> (булево)
EncryptionInfo -> (структура)
Включает всю информацию, связанную с шифрованием.
EncryptionAtRest -> (структура)
Подробности шифрования данных.
DataVolumeKMSKeyId -> (строка)
EncryptionInTransit -> (структура)
Подробности шифрования в процессе передачи.
ClientBroker -> (строка)
Указывает настройку шифрования для данных, передаваемых между клиентами и брокерами. Возможные значения:
TLS — связь клиент-брокер включена только с TLS.
TLS_PLAINTEXT — связь клиент-брокер включена для данных, зашифрованных TLS, а также для незашифрованных.
PLAINTEXT — связь клиент-брокер включена только для незашифрованных данных.
Значение по умолчанию — TLS_PLAINTEXT.
InCluster -> (булево)
При значении true указывается, что связь между узлами брокеров кластера зашифрована. При значении false связь происходит в открытом виде.
Значение по умолчанию — true.
ConnectivityInfo -> (структура)
Информация о конфигурации доступа к брокеру.
PublicAccess -> (структура)
Управление общедоступным доступом к брокерам.
Type -> (строка)
VpcConnectivity -> (структура)
Управление доступом к соединению VPC для брокеров.
ClientAuthentication -> (структура)
Включает всю информацию об аутентификации клиентов для соединения VPC.
Sasl -> (структура)
Подробности типа аутентификации SASL для подключения VPC.
Scram -> (структура)
Подробности для аутентификации клиента SASL/SCRAM для подключения VPC.
Enabled -> (булево)
Iam -> (структура)
Подробности для аутентификации клиента SASL/IAM для подключения VPC.
Enabled -> (булево)
Tls -> (структура)
Подробности типа аутентификации TLS для подключения VPC.
Enabled -> (булево)
StorageMode -> (строка)
BrokerCountUpdateInfo -> (структура)
Описание брокеров, которые изменяются во время обновления количества брокеров.
CreatedBrokerIds -> (список)
Идентификаторы брокеров Kafka, которые создаются.
(вещественное число)
DeletedBrokerIds -> (список)
Идентификаторы брокеров Kafka, которые удаляются.
(вещественное число)
VpcConnectionInfo -> (структура)
Описание подключения VPC для операций CreateVpcConnection и DeleteVpcConnection.
VpcConnectionArn -> (строка)
Owner -> (строка)
UserIdentity -> (структура)
Описание запрашивающего, который вызывает операцию API.
Type -> (строка)
PrincipalId -> (строка)
CreationTime -> (метка времени)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.