Managed Service for Apache Kafka® API, gRPC: TopicService.List

Written by

Yandex Cloud

Updated at November 26, 2024

gRPC request
ListTopicsRequest
ListTopicsResponse
Topic
TopicConfig2_8
TopicConfig3

Retrieves the list of Kafka topics in the specified cluster.

gRPC request

rpc List (ListTopicsRequest) returns (ListTopicsResponse)

ListTopicsRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field	Description
cluster_id	string Required field. ID of the Apache Kafka® cluster to list topics in. To get the cluster ID, make a ClusterService.List request.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a ListTopicsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.
page_token	string Page token. To get the next page of results, set `page_token` to the ListTopicsResponse.next_page_token returned by the previous list request.

ListTopicsResponse

{
  "topics": [
    {
      "name": "string",
      "cluster_id": "string",
      "partitions": "google.protobuf.Int64Value",
      "replication_factor": "google.protobuf.Int64Value",
      // Includes only one of the fields `topic_config_2_8`, `topic_config_3`
      "topic_config_2_8": {
        "cleanup_policy": "CleanupPolicy",
        "compression_type": "CompressionType",
        "delete_retention_ms": "google.protobuf.Int64Value",
        "file_delete_delay_ms": "google.protobuf.Int64Value",
        "flush_messages": "google.protobuf.Int64Value",
        "flush_ms": "google.protobuf.Int64Value",
        "min_compaction_lag_ms": "google.protobuf.Int64Value",
        "retention_bytes": "google.protobuf.Int64Value",
        "retention_ms": "google.protobuf.Int64Value",
        "max_message_bytes": "google.protobuf.Int64Value",
        "min_insync_replicas": "google.protobuf.Int64Value",
        "segment_bytes": "google.protobuf.Int64Value",
        "preallocate": "google.protobuf.BoolValue"
      },
      "topic_config_3": {
        "cleanup_policy": "CleanupPolicy",
        "compression_type": "CompressionType",
        "delete_retention_ms": "google.protobuf.Int64Value",
        "file_delete_delay_ms": "google.protobuf.Int64Value",
        "flush_messages": "google.protobuf.Int64Value",
        "flush_ms": "google.protobuf.Int64Value",
        "min_compaction_lag_ms": "google.protobuf.Int64Value",
        "retention_bytes": "google.protobuf.Int64Value",
        "retention_ms": "google.protobuf.Int64Value",
        "max_message_bytes": "google.protobuf.Int64Value",
        "min_insync_replicas": "google.protobuf.Int64Value",
        "segment_bytes": "google.protobuf.Int64Value",
        "preallocate": "google.protobuf.BoolValue"
      }
      // end of the list of possible fields
    }
  ],
  "next_page_token": "string"
}

Field

Description

topics[]

Topic

List of Kafka topics.

next_page_token

string

This token allows you to get the next page of results for list requests.

If the number of results is larger than ListTopicsRequest.page_size, use the next_page_token as the value for the ListTopicsRequest.page_token parameter in the next list request.
Each subsequent list request will have its own next_page_token to continue paging through the results.

Topic

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

Field	Description
name	string Name of the topic.
cluster_id	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	google.protobuf.Int64Value The number of the topic's partitions.
replication_factor	google.protobuf.Int64Value Amount of data copies (replicas) for the topic in the cluster.
topic_config_2_8	TopicConfig2_8 Includes only one of the fields `topic_config_2_8`, `topic_config_3`. User-defined settings for the topic.
topic_config_3	TopicConfig3 Includes only one of the fields `topic_config_2_8`, `topic_config_3`. User-defined settings for the topic.

TopicConfig2_8

A topic settings for 2.8

Field	Description
cleanup_policy	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.log_retention_ms 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.
compression_type	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).
delete_retention_ms	google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics.
file_delete_delay_ms	google.protobuf.Int64Value The time to wait before deleting a file from the filesystem.
flush_messages	google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig2_8.log_flush_interval_messages setting on the topic level.
flush_ms	google.protobuf.Int64Value 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.log_flush_interval_ms setting on the topic level.
min_compaction_lag_ms	google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log.
retention_bytes	google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the `delete` `cleanup_policy` 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.log_retention_bytes setting on the topic level.
retention_ms	google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig2_8.log_retention_ms setting on the topic level.
max_message_bytes	google.protobuf.Int64Value The largest record batch size allowed in topic.
min_insync_replicas	google.protobuf.Int64Value 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").
segment_bytes	google.protobuf.Int64Value 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.log_segment_bytes setting on the topic level.
preallocate	google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig2_8.log_preallocate setting on the topic level.

TopicConfig3

A topic settings for 3.x

Field	Description
cleanup_policy	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.log_retention_ms 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.
compression_type	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).
delete_retention_ms	google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics.
file_delete_delay_ms	google.protobuf.Int64Value The time to wait before deleting a file from the filesystem.
flush_messages	google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig3.log_flush_interval_messages setting on the topic level.
flush_ms	google.protobuf.Int64Value 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.log_flush_interval_ms setting on the topic level.
min_compaction_lag_ms	google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log.
retention_bytes	google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the `delete` `cleanup_policy` 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.log_retention_bytes setting on the topic level.
retention_ms	google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig3.log_retention_ms setting on the topic level.
max_message_bytes	google.protobuf.Int64Value The largest record batch size allowed in topic.
min_insync_replicas	google.protobuf.Int64Value 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").
segment_bytes	google.protobuf.Int64Value 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.log_segment_bytes setting on the topic level.
preallocate	google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig3.log_preallocate setting on the topic level.

Managed Service for Apache Kafka® API, gRPC: TopicService.List

gRPC requestgRPC request

ListTopicsRequestListTopicsRequest

ListTopicsResponseListTopicsResponse

TopicTopic

TopicConfig2_8TopicConfig2_8

TopicConfig3TopicConfig3