Skip to content

kafka describe-topics

Describe kafka topics

Description

Describing topics gives more information like leader of partition, in sync replicas etc

Synopsis

kafka describe-topics
    [--site <site>]
    [--cluster <cluster>]
    <topic>

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

cluster - (string)

     Name of kafka cluster
     Example: --cluster "cluster-1"
     Default: default      Attributes: optional

topic - (string)

     Name of the topic
     Example: "topic-1"
     Default: _None_      Attributes: required

Examples

Input:

! kafka describe-topics "test-topic-3"
Output:
[
    {
        "name": "test-topic-3",
        "partitions": [
            {
                "leader": 2,
                "replicas": [2],
                "isr": [2]
            }
        ]
    }
]

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "kafka"
Service Instance cluster
Namespace
Object Type "topic"
Object ID topics

Please see Access Control for details.