Help Center> Distributed Message Service for Kafka> API Reference (Paris Region)> APIs V2 (Recommended)> Topic Management> Creating a Topic for a Kafka Instance
Updated on 2023-08-29 GMT+08:00
View PDF

Creating a Topic for a Kafka Instance

Function

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

URI

POST /v2/{project_id}/instances/{instance_id}/topics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Minimum: 1

Maximum: 64

instance_id

Yes

String

Instance ID.

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

id

Yes

String

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

Minimum: 3

Maximum: 200

replication

No

Integer

Number of replicas, which is configured to ensure data reliability. Value range: 1 to 3.

Minimum: 1

Maximum: 3

sync_message_flush

No

Boolean

Whether synchronous flushing is enabled. The default value is false. Synchronous flushing compromises performance.

partition

No

Integer

Number of topic partitions, which is used to set the number of concurrently consumed messages.Value range: .

Minimum: 1

Maximum: 100

sync_replication

No

Boolean

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

retention_time

No

Integer

Message retention period. The default value is 72.Value range: 1–720. Unit: hour.

topic_other_configs

No

Array of topic_other_configs objects

Topic configuration.

topic_desc

No

String

Topic description.

Minimum: 0

Maximum: 200
Table 3 topic_other_configs

Parameter

Mandatory

Type

Description

name

No

String

Configuration name.

value

No

String

Configuration value.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Topic name.

Minimum: 3

Maximum: 200

name

String

Topic name.

Minimum: 3

Maximum: 200

Example Requests

Creating a topic named test01

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics

{
  "id" : "test01",
  "partition" : 3,
  "replication" : 3,
  "retention_time" : 72,
  "sync_message_flush" : false,
  "sync_replication" : "false",
  "topic_other_configs" : [ {
    "name" : "message.timestamp.type",
    "value" : "LogAppendTime"
  }, {
    "name" : "max.message.bytes",
    "value" : 10485760
  } ],
  "topic_desc" : ""
}

Example Responses

Status code: 200

The creation is successful. If the version is v1, an ID is returned. If the version is v2, a name is returned.

{
  "id" : "test01",
  "name" : "test01"
}

Status Codes

Status Code

Description

200

The creation is successful. If the version is v1, an ID is returned. If the version is v2, a name is returned.

Error Codes

See Error Codes.

Parent topic: Topic Management