Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Managed Service for Apache Kafka® API, REST: Topic.Get

Written by
Updated at November 26, 2024

Returns the specified Kafka topic.

To get the list of available Kafka topics, make a List request.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/topics/{topicName}

Path parameters

Field

Description

clusterId

string

Required field. ID of the Apache Kafka® cluster that the topic belongs to.

To get the cluster ID, make a ClusterService.List request.

topicName

string

Required field. Name of the Kafka topic resource to return.

To get the name of the topic, make a TopicService.List request.

Response

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "string",
  "partitions": "string",
  "replicationFactor": "string",
  // Includes only one of the fields `topicConfig_2_8`, `topicConfig_3`
  "topicConfig_2_8": {
    "cleanupPolicy": "string",
    "compressionType": "string",
    "deleteRetentionMs": "string",
    "fileDeleteDelayMs": "string",
    "flushMessages": "string",
    "flushMs": "string",
    "minCompactionLagMs": "string",
    "retentionBytes": "string",
    "retentionMs": "string",
    "maxMessageBytes": "string",
    "minInsyncReplicas": "string",
    "segmentBytes": "string",
    "preallocate": "boolean"
  },
  "topicConfig_3": {
    "cleanupPolicy": "string",
    "compressionType": "string",
    "deleteRetentionMs": "string",
    "fileDeleteDelayMs": "string",
    "flushMessages": "string",
    "flushMs": "string",
    "minCompactionLagMs": "string",
    "retentionBytes": "string",
    "retentionMs": "string",
    "maxMessageBytes": "string",
    "minInsyncReplicas": "string",
    "segmentBytes": "string",
    "preallocate": "boolean"
  }
  // end of the list of possible fields
}

An Kafka topic.
For more information, see the Concepts -> Topics and partitions section of the documentation.

Field

Description

name

string

Name of the topic.

clusterId

string

ID of an Apache Kafka® cluster that the topic belongs to.

To get the Apache Kafka® cluster ID, make a ClusterService.List request.

partitions

string (int64)

The number of the topic's partitions.

replicationFactor

string (int64)

Amount of data copies (replicas) for the topic in the cluster.

topicConfig_2_8

TopicConfig2_8

Includes only one of the fields topicConfig_2_8, topicConfig_3.

User-defined settings for the topic.

topicConfig_3

TopicConfig3

Includes only one of the fields topicConfig_2_8, topicConfig_3.

User-defined settings for the topic.

TopicConfig2_8

A topic settings for 2.8

Field

Description

cleanupPolicy

enum (CleanupPolicy)

Retention policy to use on old log messages.

  • CLEANUP_POLICY_UNSPECIFIED
  • CLEANUP_POLICY_DELETE: This policy discards log segments when either their retention time or log size limit is reached. See also: KafkaConfig2_8.logRetentionMs and other similar parameters.
  • CLEANUP_POLICY_COMPACT: This policy compacts messages in log.
  • CLEANUP_POLICY_COMPACT_AND_DELETE: This policy use both compaction and deletion for messages and log segments.

compressionType

enum (CompressionType)

The compression type for a given topic.

  • COMPRESSION_TYPE_UNSPECIFIED
  • COMPRESSION_TYPE_UNCOMPRESSED: no codec (uncompressed).
  • COMPRESSION_TYPE_ZSTD: Zstandard codec.
  • COMPRESSION_TYPE_LZ4: LZ4 codec.
  • COMPRESSION_TYPE_SNAPPY: Snappy codec.
  • COMPRESSION_TYPE_GZIP: GZip codec.
  • COMPRESSION_TYPE_PRODUCER: the codec to use is set by a producer (can be any of ZSTD, LZ4, GZIP or SNAPPY codecs).

deleteRetentionMs

string (int64)

The amount of time in milliseconds to retain delete tombstone markers for log compacted topics.

fileDeleteDelayMs

string (int64)

The time to wait before deleting a file from the filesystem.

flushMessages

string (int64)

The number of messages accumulated on a log partition before messages are flushed to disk.

This setting overrides the cluster-level KafkaConfig2_8.logFlushIntervalMessages setting on the topic level.

flushMs

string (int64)

The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk.

This setting overrides the cluster-level KafkaConfig2_8.logFlushIntervalMs setting on the topic level.

minCompactionLagMs

string (int64)

The minimum time in milliseconds a message will remain uncompacted in the log.

retentionBytes

string (int64)

The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanupPolicy is in effect.
It is helpful if you need to control the size of log due to limited disk space.

This setting overrides the cluster-level KafkaConfig2_8.logRetentionBytes setting on the topic level.

retentionMs

string (int64)

The number of milliseconds to keep a log segment's file before deleting it.

This setting overrides the cluster-level KafkaConfig2_8.logRetentionMs setting on the topic level.

maxMessageBytes

string (int64)

The largest record batch size allowed in topic.

minInsyncReplicas

string (int64)

This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write
to be considered successful (when a producer sets acks to "all").

segmentBytes

string (int64)

This configuration controls the segment file size for the log. Retention and cleaning is always done a file
at a time so a larger segment size means fewer files but less granular control over retention.

This setting overrides the cluster-level KafkaConfig2_8.logSegmentBytes setting on the topic level.

preallocate

boolean

True if we should preallocate the file on disk when creating a new log segment.

This setting overrides the cluster-level KafkaConfig2_8.logPreallocate setting on the topic level.

TopicConfig3

A topic settings for 3.x

Field

Description

cleanupPolicy

enum (CleanupPolicy)

Retention policy to use on old log messages.

  • CLEANUP_POLICY_UNSPECIFIED
  • CLEANUP_POLICY_DELETE: This policy discards log segments when either their retention time or log size limit is reached. See also: KafkaConfig3.logRetentionMs and other similar parameters.
  • CLEANUP_POLICY_COMPACT: This policy compacts messages in log.
  • CLEANUP_POLICY_COMPACT_AND_DELETE: This policy use both compaction and deletion for messages and log segments.

compressionType

enum (CompressionType)

The compression type for a given topic.

  • COMPRESSION_TYPE_UNSPECIFIED
  • COMPRESSION_TYPE_UNCOMPRESSED: no codec (uncompressed).
  • COMPRESSION_TYPE_ZSTD: Zstandard codec.
  • COMPRESSION_TYPE_LZ4: LZ4 codec.
  • COMPRESSION_TYPE_SNAPPY: Snappy codec.
  • COMPRESSION_TYPE_GZIP: GZip codec.
  • COMPRESSION_TYPE_PRODUCER: the codec to use is set by a producer (can be any of ZSTD, LZ4, GZIP or SNAPPY codecs).

deleteRetentionMs

string (int64)

The amount of time in milliseconds to retain delete tombstone markers for log compacted topics.

fileDeleteDelayMs

string (int64)

The time to wait before deleting a file from the filesystem.

flushMessages

string (int64)

The number of messages accumulated on a log partition before messages are flushed to disk.

This setting overrides the cluster-level KafkaConfig3.logFlushIntervalMessages setting on the topic level.

flushMs

string (int64)

The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk.

This setting overrides the cluster-level KafkaConfig3.logFlushIntervalMs setting on the topic level.

minCompactionLagMs

string (int64)

The minimum time in milliseconds a message will remain uncompacted in the log.

retentionBytes

string (int64)

The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanupPolicy is in effect.
It is helpful if you need to control the size of log due to limited disk space.

This setting overrides the cluster-level KafkaConfig3.logRetentionBytes setting on the topic level.

retentionMs

string (int64)

The number of milliseconds to keep a log segment's file before deleting it.

This setting overrides the cluster-level KafkaConfig3.logRetentionMs setting on the topic level.

maxMessageBytes

string (int64)

The largest record batch size allowed in topic.

minInsyncReplicas

string (int64)

This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write
to be considered successful (when a producer sets acks to "all").

segmentBytes

string (int64)

This configuration controls the segment file size for the log. Retention and cleaning is always done a file
at a time so a larger segment size means fewer files but less granular control over retention.

This setting overrides the cluster-level KafkaConfig3.logSegmentBytes setting on the topic level.

preallocate

boolean

True if we should preallocate the file on disk when creating a new log segment.

This setting overrides the cluster-level KafkaConfig3.logPreallocate setting on the topic level.
Previous
Overview
Next
List