Updated on 2025-08-15 GMT+08:00

Creating a Topic for a Kafka Instance

Function

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

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

instance_id

Yes

String

Definition:

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition:

Topic name.

Constraints:

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

Range:

N/A

Default Value:

N/A

replication

No

Integer

Definition:

Number of replicas, which is configured to ensure data reliability.

Constraints:

The number of replicas is related to the number of brokers. If there are three brokers, the maximum number of replicas is 3.

Range:

N/A

Default Value:

N/A

sync_message_flush

No

Boolean

Definition:

Whether to enable synchronous flushing. Synchronous flushing causes performance deterioration.

Constraints:

N/A

Range:

  • true: Yes

  • false: No

Default Value:

false

partition

No

Integer

Definition:

Number of topic partitions, which is used to set the number of the consumption concurrency.

Constraints:

N/A

Range:

1–200

Default Value:

N/A

sync_replication

No

Boolean

Definition:

Whether to enable synchronous replication.

Constraints:

N/A

Range:

  • true: yes The acks parameter on the producer client must be set to –1. Otherwise, this parameter does not take effect.

  • false: no

Default Value:

false

retention_time

No

Integer

Definition:

Message retention period.

Constraints:

N/A

Range:

1–720

Default Value:

72

topic_other_configs

No

Array of topic_other_configs objects

Definition:

Topic configuration

topic_desc

No

String

Definition:

Topic description.

Constraints:

N/A

Range:

0 to 200 characters

Default Value:

N/A

Table 3 topic_other_configs

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Configuration name.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

value

No

String

Definition:

Configuration value.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

name

String

Definition:

Topic name.

Range:

N/A

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

Successful. A topic name is returned.

{
  "name" : "test01"
}

SDK Sample Code

The SDK sample code is as follows.

Creating a topic named test01

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateInstanceTopicSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        KafkaClient client = KafkaClient.newBuilder()
                .withCredential(auth)
                .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateInstanceTopicRequest request = new CreateInstanceTopicRequest();
        request.withInstanceId("{instance_id}");
        CreateInstanceTopicReq body = new CreateInstanceTopicReq();
        List<CreateInstanceTopicReqTopicOtherConfigs> listbodyTopicOtherConfigs = new ArrayList<>();
        listbodyTopicOtherConfigs.add(
            new CreateInstanceTopicReqTopicOtherConfigs()
                .withName("message.timestamp.type")
                .withValue("LogAppendTime")
        );
        listbodyTopicOtherConfigs.add(
            new CreateInstanceTopicReqTopicOtherConfigs()
                .withName("max.message.bytes")
                .withValue("10485760")
        );
        body.withTopicDesc("");
        body.withTopicOtherConfigs(listbodyTopicOtherConfigs);
        body.withRetentionTime(72);
        body.withSyncReplication(false);
        body.withPartition(3);
        body.withSyncMessageFlush(false);
        body.withReplication(3);
        body.withId("test01");
        request.withBody(body);
        try {
            CreateInstanceTopicResponse response = client.createInstanceTopic(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Creating a topic named test01

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = KafkaClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateInstanceTopicRequest()
        request.instance_id = "{instance_id}"
        listTopicOtherConfigsbody = [
            CreateInstanceTopicReqTopicOtherConfigs(
                name="message.timestamp.type",
                value="LogAppendTime"
            ),
            CreateInstanceTopicReqTopicOtherConfigs(
                name="max.message.bytes",
                value="10485760"
            )
        ]
        request.body = CreateInstanceTopicReq(
            topic_desc="",
            topic_other_configs=listTopicOtherConfigsbody,
            retention_time=72,
            sync_replication=False,
            partition=3,
            sync_message_flush=False,
            replication=3,
            id="test01"
        )
        response = client.create_instance_topic(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Creating a topic named test01

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := kafka.NewKafkaClient(
        kafka.KafkaClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateInstanceTopicRequest{}
	request.InstanceId = "{instance_id}"
	nameTopicOtherConfigs:= "message.timestamp.type"
	valueTopicOtherConfigs:= "LogAppendTime"
	nameTopicOtherConfigs1:= "max.message.bytes"
	valueTopicOtherConfigs1:= "10485760"
	var listTopicOtherConfigsbody = []model.CreateInstanceTopicReqTopicOtherConfigs{
        {
            Name: &nameTopicOtherConfigs,
            Value: &valueTopicOtherConfigs,
        },
        {
            Name: &nameTopicOtherConfigs1,
            Value: &valueTopicOtherConfigs1,
        },
    }
	topicDescCreateInstanceTopicReq:= ""
	retentionTimeCreateInstanceTopicReq:= int32(72)
	syncReplicationCreateInstanceTopicReq:= false
	partitionCreateInstanceTopicReq:= int32(3)
	syncMessageFlushCreateInstanceTopicReq:= false
	replicationCreateInstanceTopicReq:= int32(3)
	request.Body = &model.CreateInstanceTopicReq{
		TopicDesc: &topicDescCreateInstanceTopicReq,
		TopicOtherConfigs: &listTopicOtherConfigsbody,
		RetentionTime: &retentionTimeCreateInstanceTopicReq,
		SyncReplication: &syncReplicationCreateInstanceTopicReq,
		Partition: &partitionCreateInstanceTopicReq,
		SyncMessageFlush: &syncMessageFlushCreateInstanceTopicReq,
		Replication: &replicationCreateInstanceTopicReq,
		Id: "test01",
	}
	response, err := client.CreateInstanceTopic(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Successful. A topic name is returned.

Error Codes

See Error Codes.