Updated on 2022-02-21 GMT+08:00

Creating a Topic in a Kafka Instance

Function

This API is used to create a topic in a Kafka instance.

URI

POST /v1.0/{project_id}/instances/{instance_id}/topics

Table 1 describes the parameters.

Table 1 Parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Indicates the ID of a project.

instance_id

String

Yes

Indicates the instance ID.

Request

Request parameters

Table 2 describes the parameter.

Table 2 Request parameters

Parameter

Type

Mandatory

Description

id

String

Yes

Indicates the name of a topic. A topic name consists of 4 to 64 characters, starts with a letter, and contains only letters, hyphens (-), underscores (_), and digits.

partition

Integer

No

Indicates the number of topic partitions, which is used to set the number of concurrently consumed messages.

Value range: 1–20. Default value: 3.

replication

Integer

No

Indicates the number of replicas, which is configured to ensure data reliability.

Value range: 1–3. Default value: 3.

sync_replication

Boolean

No

Indicates whether to enable synchronous replication. After this function is enabled, the acks parameter on the producer client must be set to –1. Otherwise, this parameter does not take effect.

By default, synchronous replication is disabled.

retention_time

Integer

No

Indicates the retention period of a message. Its default value is 72.

Value range: 1–168. Default value: 72. Unit: hour.

sync_message_flush

Boolean

No

Indicates whether to enable synchronous flushing. Default value: false. Synchronous flushing compromises performance.

Example request

{
  "id" : "haha", 
  "partition" : 3, 
  "replication" : 3, 
  "sync_replication " : true, 
  "retention_time" : 10, 
  "sync_message_flush" : true
}

Response

Response parameters

Table 3 describes the parameter.

Table 3 Response parameters

Parameter

Type

Description

id

String

Indicates the name of a topic.

Example response

{  
"id": "haha"
}

Status Code

Table 4 describes the status code of successful operations. For details about other status codes, see Status Code.

Table 4 Status code

Status Code

Description

200

The topic is created successfully.