Modifying Topics of a Kafka Instance
Function
This API is used to modify topics of a Kafka instance.
Calling Method
For details, see Calling APIs.
URI
PUT /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 |
---|---|---|---|
topics |
No |
Array of topics objects |
Topics that were modified. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Topic name, which cannot be modified. |
retention_time |
No |
Integer |
Aging time in hour. |
sync_replication |
No |
Boolean |
Whether synchronous replication is enabled. |
sync_message_flush |
No |
Boolean |
Whether synchronous flushing is enabled. |
new_partition_numbers |
No |
Integer |
Number of the partitions. |
new_partition_brokers |
No |
Array of integers |
Specifying brokers for new partitions. |
topic_other_configs |
No |
Array of topic_other_configs objects |
Topic configuration. |
topic_desc |
No |
String |
Topic description. |
Response Parameters
None
Example Requests
Modifying parameters of topic-1284340884. Specifically, change the aging time to 72 hours, the number of partitions to 6, timestamp to LogAppendTime, max. batch size to 10485760, specify new partitions on broker-1 and broker-2, and disable synchronous replication and flushing.
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics { "topics" : [ { "id" : "test01", "retention_time" : 72, "sync_replication" : false, "sync_message_flush" : false, "new_partition_numbers" : 6, "new_partition_brokers" : [ 1, 2 ], "topic_other_configs" : [ { "name" : "message.timestamp.type", "value" : "LogAppendTime" }, { "name" : "max.message.bytes", "value" : 10485760 } ], "topic_desc" : "This is a test topic" } ] }
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Modifying parameters of topic-1284340884. Specifically, change the aging time to 72 hours, the number of partitions to 6, timestamp to LogAppendTime, max. batch size to 10485760, specify new partitions on broker-1 and broker-2, and disable synchronous replication and flushing.
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 72 73 74 75 76 77 78 79 |
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 UpdateInstanceTopicSolution { 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(); UpdateInstanceTopicRequest request = new UpdateInstanceTopicRequest(); request.withInstanceId("{instance_id}"); UpdateInstanceTopicReq body = new UpdateInstanceTopicReq(); List<UpdateInstanceTopicReqTopicOtherConfigs> listTopicsTopicOtherConfigs = new ArrayList<>(); listTopicsTopicOtherConfigs.add( new UpdateInstanceTopicReqTopicOtherConfigs() .withName("message.timestamp.type") .withValue("LogAppendTime") ); listTopicsTopicOtherConfigs.add( new UpdateInstanceTopicReqTopicOtherConfigs() .withName("max.message.bytes") .withValue("10485760") ); List<Integer> listTopicsNewPartitionBrokers = new ArrayList<>(); listTopicsNewPartitionBrokers.add(1); listTopicsNewPartitionBrokers.add(2); List<UpdateInstanceTopicReqTopics> listbodyTopics = new ArrayList<>(); listbodyTopics.add( new UpdateInstanceTopicReqTopics() .withId("test01") .withRetentionTime(72) .withSyncReplication(false) .withSyncMessageFlush(false) .withNewPartitionNumbers(6) .withNewPartitionBrokers(listTopicsNewPartitionBrokers) .withTopicOtherConfigs(listTopicsTopicOtherConfigs) .withTopicDesc("This is a test topic") ); body.withTopics(listbodyTopics); request.withBody(body); try { UpdateInstanceTopicResponse response = client.updateInstanceTopic(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()); } } } |
Modifying parameters of topic-1284340884. Specifically, change the aging time to 72 hours, the number of partitions to 6, timestamp to LogAppendTime, max. batch size to 10485760, specify new partitions on broker-1 and broker-2, and disable synchronous replication and flushing.
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 |
# 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 = UpdateInstanceTopicRequest() request.instance_id = "{instance_id}" listTopicOtherConfigsTopics = [ UpdateInstanceTopicReqTopicOtherConfigs( name="message.timestamp.type", value="LogAppendTime" ), UpdateInstanceTopicReqTopicOtherConfigs( name="max.message.bytes", value="10485760" ) ] listNewPartitionBrokersTopics = [ 1, 2 ] listTopicsbody = [ UpdateInstanceTopicReqTopics( id="test01", retention_time=72, sync_replication=False, sync_message_flush=False, new_partition_numbers=6, new_partition_brokers=listNewPartitionBrokersTopics, topic_other_configs=listTopicOtherConfigsTopics, topic_desc="This is a test topic" ) ] request.body = UpdateInstanceTopicReq( topics=listTopicsbody ) response = client.update_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) |
Modifying parameters of topic-1284340884. Specifically, change the aging time to 72 hours, the number of partitions to 6, timestamp to LogAppendTime, max. batch size to 10485760, specify new partitions on broker-1 and broker-2, and disable synchronous replication and flushing.
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 72 73 74 75 76 |
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.UpdateInstanceTopicRequest{} request.InstanceId = "{instance_id}" nameTopicOtherConfigs:= "message.timestamp.type" valueTopicOtherConfigs:= "LogAppendTime" nameTopicOtherConfigs1:= "max.message.bytes" valueTopicOtherConfigs1:= "10485760" var listTopicOtherConfigsTopics = []model.UpdateInstanceTopicReqTopicOtherConfigs{ { Name: &nameTopicOtherConfigs, Value: &valueTopicOtherConfigs, }, { Name: &nameTopicOtherConfigs1, Value: &valueTopicOtherConfigs1, }, } var listNewPartitionBrokersTopics = []int32{ int32(1), int32(2), } retentionTimeTopics:= int32(72) syncReplicationTopics:= false syncMessageFlushTopics:= false newPartitionNumbersTopics:= int32(6) topicDescTopics:= "This is a test topic" var listTopicsbody = []model.UpdateInstanceTopicReqTopics{ { Id: "test01", RetentionTime: &retentionTimeTopics, SyncReplication: &syncReplicationTopics, SyncMessageFlush: &syncMessageFlushTopics, NewPartitionNumbers: &newPartitionNumbersTopics, NewPartitionBrokers: &listNewPartitionBrokersTopics, TopicOtherConfigs: &listTopicOtherConfigsTopics, TopicDesc: &topicDescTopics, }, } request.Body = &model.UpdateInstanceTopicReq{ Topics: &listTopicsbody, } response, err := client.UpdateInstanceTopic(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 |
---|---|
204 |
The modification is successful. |
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