更新时间:2024-03-15 GMT+08:00

修改Kafka实例Topic

功能介绍

修改Kafka实例Topic

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

最小长度:1

最大长度:64

instance_id

String

实例ID。

最小长度:1

最大长度:64

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

topics

Array of topics objects

修改的topic列表。

表3 topics

参数

是否必选

参数类型

描述

id

String

topic名称,不支持修改。

retention_time

Integer

老化时间,单位小时。

sync_replication

Boolean

是否同步复制。

sync_message_flush

Boolean

是否同步落盘。

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描述

表4 topic_other_configs

参数

是否必选

参数类型

描述

name

String

配置名称

value

String

配置值

响应参数

请求示例

修改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代码示例如下。

修改Topic参数,topic-1284340884的老化时间修改为72小时,分区数修改为6,新增分区分布在broker-1和broker-2上,不同步复制,不同步落盘,消息时间类型为LogAppendTime,最大批处理大小10485760。

 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());
        }
    }
}

修改Topic参数,topic-1284340884的老化时间修改为72小时,分区数修改为6,新增分区分布在broker-1和broker-2上,不同步复制,不同步落盘,消息时间类型为LogAppendTime,最大批处理大小10485760。

 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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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)

修改Topic参数,topic-1284340884的老化时间修改为72小时,分区数修改为6,新增分区分布在broker-1和broker-2上,不同步复制,不同步落盘,消息时间类型为LogAppendTime,最大批处理大小10485760。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

修改成功。

错误码

请参见错误码