Method get

HTTP request
Path parameters
Response

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

Parameter	Description
clusterId	Required. ID of the Apache Kafka® cluster that the topic belongs to. To get the cluster ID, make a list request. The maximum string length in characters is 50.
topicName	Required. Name of the Kafka topic resource to return. To get the name of the topic, make a list request. The string length in characters must be 1-63. Value must match the regular expression `[a-zA-Z0-9_-]*`.

Response

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "string",
  "partitions": "integer",
  "replicationFactor": "integer",

  //  includes only one of the fields `topicConfig_2_1`, `topicConfig_2_6`
  "topicConfig_2_1": {
    "cleanupPolicy": "string",
    "compressionType": "string",
    "deleteRetentionMs": "integer",
    "fileDeleteDelayMs": "integer",
    "flushMessages": "integer",
    "flushMs": "integer",
    "minCompactionLagMs": "integer",
    "retentionBytes": "integer",
    "retentionMs": "integer",
    "maxMessageBytes": "integer",
    "minInsyncReplicas": "integer",
    "segmentBytes": "integer",
    "preallocate": true
  },
  "topicConfig_2_6": {
    "cleanupPolicy": "string",
    "compressionType": "string",
    "deleteRetentionMs": "integer",
    "fileDeleteDelayMs": "integer",
    "flushMessages": "integer",
    "flushMs": "integer",
    "minCompactionLagMs": "integer",
    "retentionBytes": "integer",
    "retentionMs": "integer",
    "maxMessageBytes": "integer",
    "minInsyncReplicas": "integer",
    "segmentBytes": "integer",
    "preallocate": true
  },
  // 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 list request.
partitions	integer (int64) The number of the topic's partitions.
replicationFactor	integer (int64) Amount of data copies (replicas) for the topic in the cluster.
topicConfig_2_1	object includes only one of the fields `topicConfig_2_1`, `topicConfig_2_6` A topic settings for 2.1.
topicConfig_2_1. cleanupPolicy	string Retention policy to use on old log messages. CLEANUP_POLICY_DELETE: this policy discards log segments when either their retention time or log size limit is reached. See also: `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.
topicConfig_2_1. compressionType	string The compression type for a given topic. 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).
topicConfig_2_1. deleteRetentionMs	integer (int64) The amount of time in milliseconds to retain delete tombstone markers for log compacted topics.
topicConfig_2_1. fileDeleteDelayMs	integer (int64) The time to wait before deleting a file from the filesystem.
topicConfig_2_1. flushMessages	integer (int64) The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level `logFlushIntervalMessages` setting on the topic level.
topicConfig_2_1. flushMs	integer (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 `logFlushIntervalMs` setting on the topic level.
topicConfig_2_1. minCompactionLagMs	integer (int64) The minimum time in milliseconds a message will remain uncompacted in the log.
topicConfig_2_1. retentionBytes	integer (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 `logRetentionBytes` setting on the topic level.
topicConfig_2_1. retentionMs	integer (int64) The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level `logRetentionMs` setting on the topic level.
topicConfig_2_1. maxMessageBytes	integer (int64) The largest record batch size allowed in topic.
topicConfig_2_1. minInsyncReplicas	integer (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").
topicConfig_2_1. segmentBytes	integer (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 `logSegmentBytes` setting on the topic level.
topicConfig_2_1. preallocate	boolean (boolean) True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level `logPreallocate` setting on the topic level.
topicConfig_2_6	object includes only one of the fields `topicConfig_2_1`, `topicConfig_2_6` A topic settings for 2.6
topicConfig_2_6. cleanupPolicy	string Retention policy to use on old log messages. CLEANUP_POLICY_DELETE: this policy discards log segments when either their retention time or log size limit is reached. See also: `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.
topicConfig_2_6. compressionType	string The compression type for a given topic. 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).
topicConfig_2_6. deleteRetentionMs	integer (int64) The amount of time in milliseconds to retain delete tombstone markers for log compacted topics.
topicConfig_2_6. fileDeleteDelayMs	integer (int64) The time to wait before deleting a file from the filesystem.
topicConfig_2_6. flushMessages	integer (int64) The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level `logFlushIntervalMessages` setting on the topic level.
topicConfig_2_6. flushMs	integer (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 `logFlushIntervalMs` setting on the topic level.
topicConfig_2_6. minCompactionLagMs	integer (int64) The minimum time in milliseconds a message will remain uncompacted in the log.
topicConfig_2_6. retentionBytes	integer (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 `logRetentionBytes` setting on the topic level.
topicConfig_2_6. retentionMs	integer (int64) The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level `logRetentionMs` setting on the topic level.
topicConfig_2_6. maxMessageBytes	integer (int64) The largest record batch size allowed in topic.
topicConfig_2_6. minInsyncReplicas	integer (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").
topicConfig_2_6. segmentBytes	integer (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 `logSegmentBytes` setting on the topic level.
topicConfig_2_6. preallocate	boolean (boolean) True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level `logPreallocate` setting on the topic level.