Updated on 2024-08-07 GMT+08:00

Reassigning Replicas of a Topic for a Kafka Instance

Function

This API is used to reassign replicas of a topic for a Kafka instance.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/instances/{instance_id}/management/topics/{topic}/replicas-reassignment

Table 1 Path Parameters

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.

topic

Yes

String

Topic name.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

partitions

No

Array of partitions objects

Assignment of replicas of the partition after the change.

Table 3 partitions

Parameter

Mandatory

Type

Description

partition

No

Integer

Partition ID.

replicas

No

Array of integers

ID of the broker where the replica is expected to reside. The first integer in the array represents the leader replica broker ID. All partitions must have the same number of replicas. The number of replicas cannot be larger than the number of brokers.

Response Parameters

None

Example Requests

Reassigning topic partitions, with replicas of partition 1 on brokers 1 and 2, and the leader replica on broker 1

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}/replicas-reassignment

{
  "partitions" : [ {
    "partition" : 1,
    "replicas" : [ 1, 2 ]
  }, {
    "partition" : 0,
    "replicas" : [ 0, 1 ]
  } ]
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Reassigning topic partitions, with replicas of partition 1 on brokers 1 and 2, and the leader replica on broker 1

 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 UpdateTopicReplicaSolution {

    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();
        UpdateTopicReplicaRequest request = new UpdateTopicReplicaRequest();
        request.withInstanceId("{instance_id}");
        request.withTopic("{topic}");
        ResetReplicaReq body = new ResetReplicaReq();
        List<Integer> listPartitionsReplicas = new ArrayList<>();
        listPartitionsReplicas.add(0);
        listPartitionsReplicas.add(1);
        List<Integer> listPartitionsReplicas1 = new ArrayList<>();
        listPartitionsReplicas1.add(1);
        listPartitionsReplicas1.add(2);
        List<ResetReplicaReqPartitions> listbodyPartitions = new ArrayList<>();
        listbodyPartitions.add(
            new ResetReplicaReqPartitions()
                .withPartition(1)
                .withReplicas(listPartitionsReplicas1)
        );
        listbodyPartitions.add(
            new ResetReplicaReqPartitions()
                .withPartition(0)
                .withReplicas(listPartitionsReplicas)
        );
        body.withPartitions(listbodyPartitions);
        request.withBody(body);
        try {
            UpdateTopicReplicaResponse response = client.updateTopicReplica(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());
        }
    }
}

Reassigning topic partitions, with replicas of partition 1 on brokers 1 and 2, and the leader replica on broker 1

 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
# 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 = UpdateTopicReplicaRequest()
        request.instance_id = "{instance_id}"
        request.topic = "{topic}"
        listReplicasPartitions = [
            0,
            1
        ]
        listReplicasPartitions1 = [
            1,
            2
        ]
        listPartitionsbody = [
            ResetReplicaReqPartitions(
                partition=1,
                replicas=listReplicasPartitions1
            ),
            ResetReplicaReqPartitions(
                partition=0,
                replicas=listReplicasPartitions
            )
        ]
        request.body = ResetReplicaReq(
            partitions=listPartitionsbody
        )
        response = client.update_topic_replica(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Reassigning topic partitions, with replicas of partition 1 on brokers 1 and 2, and the leader replica on broker 1

 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
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.UpdateTopicReplicaRequest{}
	request.InstanceId = "{instance_id}"
	request.Topic = "{topic}"
	var listReplicasPartitions = []int32{
        int32(0),
	    int32(1),
    }
	var listReplicasPartitions1 = []int32{
        int32(1),
	    int32(2),
    }
	partitionPartitions:= int32(1)
	partitionPartitions1:= int32(0)
	var listPartitionsbody = []model.ResetReplicaReqPartitions{
        {
            Partition: &partitionPartitions,
            Replicas: &listReplicasPartitions1,
        },
        {
            Partition: &partitionPartitions1,
            Replicas: &listReplicasPartitions,
        },
    }
	request.Body = &model.ResetReplicaReq{
		Partitions: &listPartitionsbody,
	}
	response, err := client.UpdateTopicReplica(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 replicas are reassigned successfully.

Error Codes

See Error Codes.