Describe topic

Request

curl https://api.warpstream.com/api/v1/describe_topic \
-H 'warpstream-api-key: XXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{"virtual_cluster_id": "vci_1d4930d7_8e6d_4ad9_b27a_654ed4aaa3ee", "topic_name": "my_topic", "include_default_configs": true}'

Response

{
    "partition_count":128,
    "configs":{
        "cleanup.policy":"delete",
        "compression.type":"lz4",
        "delete.retention.ms":"86400000",
        "file.delete.delay.ms":"60000",
        "flush.messages":"1",
        "flush.ms":"0",
        "follower.replication.throttled.replicas":"",
        "index.interval.bytes":"4096",
        "leader.replication.throttled.replicas":"",
        "max.compaction.lag.ms":"9223372036854775807",
        "message.downconversion.enable":"true",
        "message.timestamp.difference.max.ms":"9223372036854775807",
        "message.timestamp.type":"CreateTime",
        "min.cleanable.dirty.ratio":"0.5",
        "min.compaction.lag.ms":"0",
        "min.insync.replicas":"1",
        "preallocate":"false",
        "retention.bytes":"-1",
        "retention.ms":"604800000",
        "segment.bytes":"1073741824",
        "segment.index.bytes":"10485760",
        "segment.jitter.ms":"0",
        "segment.ms":"604800000",
        "unclean.leader.election.enable":"false",
        "warpstream.compression.type.fetch":"agent",
        "warpstream.deletion.protection.enabled":"false",
        "warpstream.key.schema.validation":"false",
        "warpstream.key.subject.name.strategy":"TopicNameStrategy",
        "warpstream.partitions_auto_scaler.enabled":"false",
        "warpstream.partitions_auto_scaler.max_partition_count":"0",
        "warpstream.partitions_auto_scaler.per_partition_throughput_uncompressed_bytes_per_second":"2500000",
        "warpstream.schema.registry.type":"STANDARD",
        "warpstream.schema.validation.warning.only":"true",
        "warpstream.value.schema.validation":"false",
        "warpstream.value.subject.name.strategy":"TopicNameStrategy"
    }
}

Last updated

Was this helpful?