# 注册DMS kafka实例 - RegisterDmsKafkaInstance #### 功能介绍 该接口用于注册DMS kafka实例。 ![](https://support.huaweicloud.com/api-lts/public_sys-resources/note_3.0-zh-cn.png) 在注册DMS kafka实例前，需要在安全组中，开放入方向规则198.19.128.0/17和9011端口。 如果DMS kafka实例的子网配置了ACL，则需要在该子网的网络ACL中，开放入方向规则198.19.128.0/17和9011端口。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-lts/lts_api_0003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lts/lts_api_0046.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | lts:transfer:registerDmsKafkaInstance | Write | - | - | - | dms:instance:list | #### URI POST /v2/{project_id}/lts/dms/kafka-instance 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token，获取方式请参见： [获取用户Token](https://support.huaweicloud.com/api-lts/lts_api_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 用于定义消息体的格式，该字段填为：application/json;charset=utf8。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_id | 是 | String | kafka ID | | kafka_name | 是 | String | kafka 名称 | | connect_info | 是 | [connectInfo] object | kafka连接信息。购买kafka时，SASL_SSL是否配置，如果有，则需要填写账号密码 | 表4connectInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user_name | 否 | String | **参数解释：** 账号。 **约束限制：** 不涉及。 | | pwd | 否 | String | **参数解释：** 密码。 **约束限制：** 不涉及。 | #### 响应参数 **状态码：201** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | kafka ID | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | 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代码示例如下。 - [Java] 注册DMS kafka实例 ``` 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("")) .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()); } } } ``` - [Python] 注册DMS kafka实例 ``` # 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("")) \ .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) ``` - [Go] 注册DMS kafka实例 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := lts.LtsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := lts.NewLtsClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/LTS/sdk?api=RegisterDmsKafkaInstance)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | 注册DmsKafka请求响应成功。 | | 400 | 非法请求 建议根据error_msg直接修改该请求。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。