KafkaClusterDescription is a datatype for a Kafka cluster description. It's used by the kafkaCluster() query field.

Table: KafkaClusterDescription

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 25, 2024
chatterTopicKafkaTopicDescriptionyes Short-TermAny chatter topic associated with the Kafka cluster. See KafkaTopicDescription.
clusterIDstringyes Short-TermThe unique identifier of the cluster.
controllerKafkaNodeyes Short-TermThe Kafka node that is the controller of the cluster. See KafkaNode.
globalEventsTopicKafkaTopicDescriptionyes Short-TermThe global Kafka events topic. See KafkaTopicDescription.
ingestTopicKafkaTopicDescriptionyes Short-TermA description of the Kafka ingest topic. See KafkaTopicDescription.
logDirDescriptions[KafkaLogDir]yes Short-TermDescriptions of the Kafka log directories. See KafkaLogDir.
nodes[KafkaNode]yes Short-TermThe list of Kafka nodes in the cluster. See KafkaNode.