更新时间:2025-08-13 GMT+08:00
分享

注册DMS kafka实例

功能介绍

该接口用于注册DMS kafka实例。

在注册DMS kafka实例前,需要在安全组中,开放入方向规则198.19.128.0/17和9011端口。

如果DMS kafka实例的子网配置了ACL,则需要在该子网的网络ACL中,开放入方向规则198.19.128.0/17和9011端口。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

从IAM服务获取的用户Token,获取方式请参见: 获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

用于定义消息体的格式,该字段填为:application/json;charset=utf8。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

instance_id

String

kafka ID

最小长度:1

最大长度:36

kafka_name

String

kafka 名称

最小长度:1

最大长度:256

connect_info

connect_info object

kafka连接信息。购买kafka时,SASL_SSL是否配置,如果有,则需要填写账号密码

表4 connect_info

参数

是否必选

参数类型

描述

user_name

String

参数解释:

账号。

约束限制:

不涉及。

pwd

String

参数解释:

密码。

约束限制:

不涉及。

响应参数

状态码:201

表5 响应Body参数

参数

参数类型

描述

instance_id

String

kafka ID

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见:错误码

取值范围:

不涉及。

error_msg

String

参数解释:

调用失败响应信息描述。

取值范围:

不涉及。

请求示例

注册DMS kafka实例

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

响应示例

状态码:201

注册DmsKafka请求响应成功。

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

状态码:400

非法请求 建议根据error_msg直接修改该请求。

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

状态码:500

表明服务端能被请求访问到,但是服务内部出错。

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

SDK代码示例

SDK代码示例如下。

注册DMS kafka实例

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

注册DMS kafka实例

 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)

注册DMS kafka实例

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

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

状态码

状态码

描述

201

注册DmsKafka请求响应成功。

400

非法请求 建议根据error_msg直接修改该请求。

500

表明服务端能被请求访问到,但是服务内部出错。

错误码

请参见错误码

相关文档