Managed Service for Apache Kafka® API, REST: Topic.list
Retrieves the list of Kafka topics in the specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}/topics
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Apache Kafka® cluster to list topics in. To get the cluster ID, make a list request. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"topics": [
{
"name": "string",
"clusterId": "string",
"partitions": "integer",
"replicationFactor": "integer",
// `topics[]` includes only one of the fields `topicConfig_2_8`, `topicConfig_3`
"topicConfig_2_8": {
"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_3": {
"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`topics[]`
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
topics[] | object List of Kafka topics. |
topics[]. name |
string Name of the topic. |
topics[]. clusterId |
string ID of an Apache Kafka® cluster that the topic belongs to. To get the Apache Kafka® cluster ID, make a list request. |
topics[]. partitions |
integer (int64) The number of the topic's partitions. |
topics[]. replicationFactor |
integer (int64) Amount of data copies (replicas) for the topic in the cluster. |
topics[]. topicConfig_2_8 |
object topics[] includes only one of the fields topicConfig_2_8 , topicConfig_3 A topic settings for 2.8 |
topics[]. topicConfig_2_8. cleanupPolicy |
string Retention policy to use on old log messages.
|
topics[]. topicConfig_2_8. compressionType |
string The compression type for a given topic.
|
topics[]. topicConfig_2_8. deleteRetentionMs |
integer (int64) The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
topics[]. topicConfig_2_8. fileDeleteDelayMs |
integer (int64) The time to wait before deleting a file from the filesystem. |
topics[]. topicConfig_2_8. flushMessages |
integer (int64) The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level |
topics[]. topicConfig_2_8. 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 |
topics[]. topicConfig_2_8. minCompactionLagMs |
integer (int64) The minimum time in milliseconds a message will remain uncompacted in the log. |
topics[]. topicConfig_2_8. retentionBytes |
integer (int64) The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the This setting overrides the cluster-level |
topics[]. topicConfig_2_8. retentionMs |
integer (int64) The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level |
topics[]. topicConfig_2_8. maxMessageBytes |
integer (int64) The largest record batch size allowed in topic. |
topics[]. topicConfig_2_8. 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"). |
topics[]. topicConfig_2_8. 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 |
topics[]. topicConfig_2_8. preallocate |
boolean (boolean) True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level |
topics[]. topicConfig_3 |
object topics[] includes only one of the fields topicConfig_2_8 , topicConfig_3 A topic settings for 3.x |
topics[]. topicConfig_3. cleanupPolicy |
string Retention policy to use on old log messages.
|
topics[]. topicConfig_3. compressionType |
string The compression type for a given topic.
|
topics[]. topicConfig_3. deleteRetentionMs |
integer (int64) The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
topics[]. topicConfig_3. fileDeleteDelayMs |
integer (int64) The time to wait before deleting a file from the filesystem. |
topics[]. topicConfig_3. flushMessages |
integer (int64) The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level |
topics[]. topicConfig_3. 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 |
topics[]. topicConfig_3. minCompactionLagMs |
integer (int64) The minimum time in milliseconds a message will remain uncompacted in the log. |
topics[]. topicConfig_3. retentionBytes |
integer (int64) The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the This setting overrides the cluster-level |
topics[]. topicConfig_3. retentionMs |
integer (int64) The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level |
topics[]. topicConfig_3. maxMessageBytes |
integer (int64) The largest record batch size allowed in topic. |
topics[]. topicConfig_3. 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"). |
topics[]. topicConfig_3. 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 |
topics[]. topicConfig_3. preallocate |
boolean (boolean) True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |