# 修改Kafka实例Topic - UpdateInstanceTopic #### 功能介绍 修改Kafka实例Topic #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-kafka/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-kafka/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dms:topic:modify | Write | kafka | - g:ResourceTag/\ - g:EnterpriseProjectId | dms:instance:modify | - | | dms:topic:modify | Write | topic \* | - | dms:instance:modify | - | #### URI PUT /v2/{project_id}/instances/{instance_id}/topics 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-kafka/kafka-api-0036212547.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | topics | 否 | Array of [topics] objects | **参数解释**： 待修改的Topic列表。 **约束限制**： 不涉及。 | 表3topics | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释**： Topic名称，不支持修改。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | retention_time | 否 | Integer | **参数解释**： 老化时间，单位小时。 **约束限制**： 不涉及。 **取值范围**： 0-720。 **默认取值**： 不涉及。 | | sync_replication | 否 | Boolean | **参数解释**： 是否同步复制。 **约束限制**： 不涉及。 **取值范围**： - true：开启同步复制。 - false：不开启同步复制。 **默认取值**： 不涉及。 | | sync_message_flush | 否 | Boolean | **参数解释**： 是否同步落盘。 **约束限制**： 不涉及。 **取值范围**： - true：开启同步落盘。 - false：不开启同步落盘。 **默认取值**： 不涉及。 | | new_partition_numbers | 否 | Integer | **参数解释**： 分区数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | new_partition_brokers | 否 | Array of integers | **参数解释**： 增加分区时指定broker列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | topic_other_configs | 否 | Array of [topic_other_configs] objects | **参数解释**： Topic配置。 **约束限制**： 不涉及。 | | topic_desc | 否 | String | **参数解释**： Topic描述。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表4topic_other_configs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 配置名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | value | 否 | String | **参数解释**： 配置值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：204** 修改成功。 无 #### 请求示例 修改Topic参数，topic-1284340884的老化时间修改为72小时，分区数修改为6，新增分区分布在broker-1和broker-2上，不同步复制，不同步落盘，消息时间类型为LogAppendTime，最大批处理大小10485760。 ``` 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" } ] } ``` #### 响应示例 无 #### SDK代码示例 SDK代码示例如下。 - [Java] 修改Topic参数，topic-1284340884的老化时间修改为72小时，分区数修改为6，新增分区分布在broker-1和broker-2上，不同步复制，不同步落盘，消息时间类型为LogAppendTime，最大批处理大小10485760。 ``` 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("")) .build(); UpdateInstanceTopicRequest request = new UpdateInstanceTopicRequest(); request.withInstanceId("{instance_id}"); UpdateInstanceTopicReq body = new UpdateInstanceTopicReq(); List listTopicsTopicOtherConfigs = new ArrayList<>(); listTopicsTopicOtherConfigs.add( new UpdateInstanceTopicReqTopicOtherConfigs() .withName("message.timestamp.type") .withValue("LogAppendTime") ); listTopicsTopicOtherConfigs.add( new UpdateInstanceTopicReqTopicOtherConfigs() .withName("max.message.bytes") .withValue("10485760") ); List listTopicsNewPartitionBrokers = new ArrayList<>(); listTopicsNewPartitionBrokers.add(1); listTopicsNewPartitionBrokers.add(2); List 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()); } } } ``` - [Python] 修改Topic参数，topic-1284340884的老化时间修改为72小时，分区数修改为6，新增分区分布在broker-1和broker-2上，不同步复制，不同步落盘，消息时间类型为LogAppendTime，最大批处理大小10485760。 ``` # 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("")) \ .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) ``` - [Go] 修改Topic参数，topic-1284340884的老化时间修改为72小时，分区数修改为6，新增分区分布在broker-1和broker-2上，不同步复制，不同步落盘，消息时间类型为LogAppendTime，最大批处理大小10485760。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := kafka.NewKafkaClient(hcClient) 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Kafka/sdk?api=UpdateInstanceTopic)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 204 | 修改成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-kafka/ErrorCode.html)。