Help Center/ Log Tank Service/ API Reference/ APIs/ Log Transfer/ Registering a DMS Kafka Instance
Updated on 2025-08-21 GMT+08:00

Registering a DMS Kafka Instance

Function

This API is used to register a DMS Kafka instance.

Before registering a DMS Kafka instance, configure an inbound rule to allow access from 198.19.128.0/17 over port 9011.

If a network access control list (ACL) has been configured for the subnet of this instance, configure inbound rules for the network ACL to allow access from 198.19.128.0/17 over port 9011.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/lts/dms/kafka-instance

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. It can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Message body format. Set this parameter to application/json;charset=utf8.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

kafka ID

Minimum: 1

Maximum: 36

kafka_name

Yes

String

Kafka name.

Minimum: 1

Maximum: 256

connect_info

Yes

connect_info object

Kafka connection information. This parameter is required if you have configured SASL_SSL when purchasing the Kafka instance.

Table 4 connect_info

Parameter

Mandatory

Type

Description

user_name

No

String

Definition

Account.

Constraints

N/A

pwd

No

String

Definition

Password.

Constraints

N/A

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

instance_id

String

kafka ID

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code. For details, see Error Codes.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code. For details, see Error Codes.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Requests

Registering a DMS Kafka instance

POST https://{endpoint}/v2/{project_id}/lts/dms/kafka-instance

{
  "instance_id" : "3f4a92ff-7f65-489f-a36a-fadbaaxxxxx6",
  "kafka_name" : "kafka-wxxxxxt",
  "connect_info" : {
    "user_name" : "111",
    "pwd" : "2222"
  }
}

Example Responses

Status code: 201

The registration is successful.

{
  "instance_id" : "3f4a92ff-7f65-489f-a36a-fadbaaxxxxx6"
}

Status code: 400

Invalid request. Modify the request based on the description in error_msg before a retry.

{
  "error_code" : "LTS.1719",
  "error_msg" : "kafka user or password wrong"
}

Status code: 500

The server has received the request but encountered an internal error.

{
  "error_code" : "LTS.0010",
  "error_msg" : "The system encountered an internal error"
}

SDK Sample Code

The SDK sample code is as follows.

Registering a DMS Kafka instance

 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
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.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;


public class RegisterDmsKafkaInstanceSolution {

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

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        RegisterDmsKafkaInstanceRequest request = new RegisterDmsKafkaInstanceRequest();
        RegisterDmsKafkaInstanceRequestBody body = new RegisterDmsKafkaInstanceRequestBody();
        RegisterDmsKafkaInstanceRequestBodyConnectInfo connectInfobody = new RegisterDmsKafkaInstanceRequestBodyConnectInfo();
        connectInfobody.withUserName("111")
            .withPwd("2222");
        body.withConnectInfo(connectInfobody);
        body.withKafkaName("kafka-wxxxxxt");
        body.withInstanceId("3f4a92ff-7f65-489f-a36a-fadbaaxxxxx6");
        request.withBody(body);
        try {
            RegisterDmsKafkaInstanceResponse response = client.registerDmsKafkaInstance(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());
        }
    }
}

Registering a DMS Kafka instance

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.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 = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RegisterDmsKafkaInstanceRequest()
        connectInfobody = RegisterDmsKafkaInstanceRequestBodyConnectInfo(
            user_name="111",
            pwd="2222"
        )
        request.body = RegisterDmsKafkaInstanceRequestBody(
            connect_info=connectInfobody,
            kafka_name="kafka-wxxxxxt",
            instance_id="3f4a92ff-7f65-489f-a36a-fadbaaxxxxx6"
        )
        response = client.register_dms_kafka_instance(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Registering a DMS Kafka instance

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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 := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RegisterDmsKafkaInstanceRequest{}
	userNameConnectInfo:= "111"
	pwdConnectInfo:= "2222"
	connectInfobody := &model.RegisterDmsKafkaInstanceRequestBodyConnectInfo{
		UserName: &userNameConnectInfo,
		Pwd: &pwdConnectInfo,
	}
	request.Body = &model.RegisterDmsKafkaInstanceRequestBody{
		ConnectInfo: connectInfobody,
		KafkaName: "kafka-wxxxxxt",
		InstanceId: "3f4a92ff-7f65-489f-a36a-fadbaaxxxxx6",
	}
	response, err := client.RegisterDmsKafkaInstance(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

201

The registration is successful.

400

Invalid request. Modify the request based on the description in error_msg before a retry.

500

The server has received the request but encountered an internal error.

Error Codes

See Error Codes.