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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain it, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Topic name. A topic name consists of 3 to 200 characters, starts with a letter, and contains only letters, hyphens (-), underscores (_), periods (.), and digits. |
replication |
No |
Integer |
Number of replicas, which is configured to ensure data reliability. Value range: 1 to 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: 1–200 |
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 |
Indicates the retention period of a message. The default value is 72.The value range is 1–720, in hours. |
topic_other_configs |
No |
Array of topic_other_configs objects |
Topic configuration. |
topic_desc |
No |
String |
Topic description. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
name |
String |
Topic name. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot