описание-операции-кластера
Описание
Возвращает описание операции кластера, указанной по ARN.
См. также: Документация API AWS
Синтаксис
describe-cluster-operation
--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 (строка)
--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
- текст
- таблица
- 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.
Вывод
ClusterOperationInfo -> (структура)
Информация об операции кластера
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.
EnabledInBroker -> (булево)
NodeExporter -> (структура)
Указывает, хотите ли вы включить или выключить экспортер узлов.
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 -> (список)
Список 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 -> (список)
Список 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 -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.