describe-cluster-operation-v2
Описание
Возвращает описание операции с кластером, указанной по ARN.
См. также: Документация API AWS
Синтаксис
describe-cluster-operation-v2
--cluster-operation-arn <value>
[--cli-input-json | --cli-input-yaml]
[--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-operation-arn (строка) ARN операции с кластером для описания.
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения перепишут значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--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.
Выходные данные
ClusterOperationInfo -> (структура)
Информация об операции кластера
ClusterArn -> (строка)
ClusterType -> (строка)
StartTime -> (метка времени)
EndTime -> (метка времени)
ErrorInfo -> (структура)
Если операция кластера завершилась ошибкой, она описывает ошибку.
ErrorCode -> (строка)
ErrorString -> (строка)
OperationArn -> (строка)
OperationState -> (строка)
OperationType -> (строка)
Provisioned -> (структура)
Свойства кластера с предварительным выделением ресурсов.
OperationSteps -> (список)
Шаги, выполненные во время операции.
(структура)
Шаг, выполненный во время операции кластера.
StepInfo -> (структура)
Информация о шаге и его статусе.
StepStatus -> (строка)
StepName -> (строка)
SourceClusterInfo -> (структура)
Информация о характеристиках кластера до обновления кластера.
BrokerEBSVolumeInfo -> (список)
Указывает размер тома EBS и идентификатор связанного брокера.
(структура)
Указывает информацию об обновлении тома EBS. Идентификатор брокера должен быть установлен в ключевое слово ALL. Это означает, что изменения применяются ко всем брокерам в кластере.
KafkaBrokerNodeId -> (строка)
ProvisionedThroughput -> (структура)
Информация о пропускной способности предварительно выделенного тома EBS.
Enabled -> (булево)
VolumeThroughput -> (целое число)
VolumeSizeGB -> (целое число)
ConfigurationInfo -> (структура)
Информация о изменениях в конфигурации брокеров.
Arn -> (строка)
Revision -> (длинное целое число)
NumberOfBrokerNodes -> (целое число)
EnhancedMonitoring -> (строка)
OpenMonitoring -> (структура)
Настройки для мониторинга.
Prometheus -> (структура)
Настройки Prometheus.
JmxExporter -> (структура)
Указывает, хотите ли вы включить или отключить экспортер JMX.
EnabledInBroker -> (булево)
NodeExporter -> (структура)
Указывает, хотите ли вы включить или отключить экспортер Node.
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 -> (структура)
Подробности для ClientAuthentication с использованием SASL.
Scram -> (структура)
Подробности для аутентификации клиента SASL/SCRAM.
Enabled -> (булево)
Iam -> (структура)
Указывает, включен ли контроль доступа IAM.
Enabled -> (булево)
Tls -> (структура)
Подробности для ClientAuthentication с использованием TLS.
CertificateAuthorityArnList -> (список)
Список ARNs центров сертификации 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 -> (временная метка)
Serverless -> (структура)
Свойства бессерверного кластера.
VpcConnectionInfo -> (структура)
Описание подключения к VPC для операций CreateVpcConnection и DeleteVpcConnection.
CreationTime -> (временная метка)
Owner -> (строка)
UserIdentity -> (структура)
Описание запрашивающего пользователя, который выполняет операцию API.
Type -> (строка)
PrincipalId -> (строка)
VpcConnectionArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.