confluent kafka topic describe¶

Tip

For Confluent Cloud, this command introduces new functionality that differs from the previous version. The original functionality to list configurations is now available in confluent kafka topic configuration list.

Description¶

Describe a Kafka topic.

confluent kafka topic describe <topic> [flags]

Flags¶

    --kafka-endpoint string   Endpoint to be used for this Kafka cluster.
    --cluster string          Kafka cluster ID.
    --context string          CLI context name.
    --environment string      Environment ID.
-o, --output string           Specify the output format as "human", "json", or "yaml". (default "human")

    --url string                          Base URL of REST Proxy Endpoint of Kafka Cluster (include "/kafka" for embedded Rest Proxy). Must set flag or CONFLUENT_REST_URL.
    --certificate-authority-path string   Path to a PEM-encoded Certificate Authority to verify the Confluent REST Proxy.
    --client-cert-path string             Path to client cert to be verified by Confluent REST Proxy. Include for mTLS authentication.
    --client-key-path string              Path to client private key, include for mTLS authentication.
    --no-authentication                   Include if requests should be made without authentication headers and user will not be prompted for credentials.
    --prompt                              Bypass use of available login credentials and prompt for Kafka Rest credentials.
-o, --output string                       Specify the output format as "human", "json", or "yaml". (default "human")

Global Flags¶

-h, --help            Show help for this command.
    --unsafe-trace    Equivalent to -vvvv, but also log HTTP requests and responses which might contain plaintext secrets.
-v, --verbose count   Increase verbosity (-v for warn, -vv for info, -vvv for debug, -vvvv for trace).

Examples¶

Describe the “my_topic” topic.

confluent kafka topic describe my_topic

Describe the “my_topic” topic for the specified cluster (providing embedded Kafka REST Proxy endpoint).

confluent kafka topic describe my_topic --url http://localhost:8090/kafka

Describe the “my_topic” topic for the specified cluster (providing Kafka REST Proxy endpoint).

confluent kafka topic describe my_topic --url http://localhost:8082