Managed Service for Apache Kafka® API, REST: Topic.create
Creates a new Kafka topic in the specified cluster.
HTTP request
POST 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 create a topic in. To get the cluster ID, make a list request. The maximum string length in characters is 50. |
Body parameters
{
"topicSpec": {
"name": "string",
"partitions": "integer",
"replicationFactor": "integer",
// `topicSpec` 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`topicSpec`
}
}
Field | Description |
---|---|
topicSpec | object Required. Configuration of the topic to create. |
topicSpec. name |
string Name of the topic. |
topicSpec. partitions |
integer (int64) The number of the topic's partitions. |
topicSpec. replicationFactor |
integer (int64) Amount of copies of a topic data kept in the cluster. |
topicSpec. topicConfig_2_8 |
object topicSpec includes only one of the fields topicConfig_2_8 , topicConfig_3 A topic settings for 2.8 |
topicSpec. topicConfig_2_8. cleanupPolicy |
string Retention policy to use on old log messages.
|
topicSpec. topicConfig_2_8. compressionType |
string The compression type for a given topic.
|
topicSpec. topicConfig_2_8. deleteRetentionMs |
integer (int64) The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
topicSpec. topicConfig_2_8. fileDeleteDelayMs |
integer (int64) The time to wait before deleting a file from the filesystem. |
topicSpec. 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 |
topicSpec. 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 |
topicSpec. topicConfig_2_8. minCompactionLagMs |
integer (int64) The minimum time in milliseconds a message will remain uncompacted in the log. |
topicSpec. 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 |
topicSpec. 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 |
topicSpec. topicConfig_2_8. maxMessageBytes |
integer (int64) The largest record batch size allowed in topic. |
topicSpec. 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"). |
topicSpec. 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 |
topicSpec. 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 |
topicSpec. topicConfig_3 |
object topicSpec includes only one of the fields topicConfig_2_8 , topicConfig_3 A topic settings for 3.x |
topicSpec. topicConfig_3. cleanupPolicy |
string Retention policy to use on old log messages.
|
topicSpec. topicConfig_3. compressionType |
string The compression type for a given topic.
|
topicSpec. topicConfig_3. deleteRetentionMs |
integer (int64) The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
topicSpec. topicConfig_3. fileDeleteDelayMs |
integer (int64) The time to wait before deleting a file from the filesystem. |
topicSpec. 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 |
topicSpec. 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 |
topicSpec. topicConfig_3. minCompactionLagMs |
integer (int64) The minimum time in milliseconds a message will remain uncompacted in the log. |
topicSpec. 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 |
topicSpec. 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 |
topicSpec. topicConfig_3. maxMessageBytes |
integer (int64) The largest record batch size allowed in topic. |
topicSpec. 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"). |
topicSpec. 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 |
topicSpec. 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 |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
createdBy | string ID of the user or service account who initiated the operation. |
modifiedAt | string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |