更新数据连接信息 - UpdateDataconnection

功能介绍

更新数据连接信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

PUT /v1/{project_id}/data-connections/{data_connection_id}

表1 路径参数
参数	是否必选	参数类型	描述
data_connection_id	是	String	数据连接id，可通过数据连接列表中获取。
project_id	是	String	项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。
workspace	是	String	工作空间ID ，获取方法请参见实例ID和工作空间ID。

表3 请求Body参数
参数	是否必选	参数类型	描述
data_source_vos	是	Array of ApigDataSourceVo objects	数据源结构体。
mode	否	Integer	工作空间模式，0：简单模式；1：企业模式，默认为0。

表4 ApigDataSourceVo
参数	是否必选	参数类型	描述
dw_name	是	String	数据连接名称，创建时自定义，编辑时通过数据连接列表获取。
dw_type	是	String	数据连接类型，如：DWS、DLI、HIVE、RDS、SparkSQL等，可在console界面查看所有数据连接类型，编辑时通过数据连接列表获取。
dw_config	是	Object	连接动态变化配置项，每种连接略有区别，建议先在界面进行调试获取每种数据源参数样例。
agent_name	否	String	CDM集群名称，获取方法请参见查询集群列表，对于大多数场景都需要填写使用的集群，可以在界面进行确认是否必填。
agent_id	否	String	CDM集群ID，获取方法请参见查询集群列表，对于大多数场景都需要填写使用的集群，可以在界面进行确认是否必填。
support_service	否	String	适用组件，允许使用本数据连接的组件，建议先在界面勾选需要的组件并进行调试，获取相应参数值。默认全选连接配置能支持的所有适用组件。
description	否	String	数据连接描述信息。
dw_category	否	String	数据连接标签。
env_type	否	Integer	环境类型，简单模式工作空间不需填写，企业模式工作空间下的数据连接区分不同环境。1：开发环境；2：生产环境。
create_user	否	String	数据连接创建者。
create_time	否	Number	数据连接创建时间，时间戳。
dw_id	否	String	数据连接id，可通过数据连接列表中获取，创建连接时不用填写。
qualified_name	否	String	数据连接限定名称。

响应参数

状态码：200

Success，数据连接信息更新成功。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_msg	String	返回的错误信息。
error_code	String	返回的错误码。

状态码：500

表6 响应Body参数
参数	参数类型	描述
error_msg	String	返回的错误信息。
error_code	String	返回的错误码。

请求示例

更新MRS HBASE类型的数据连接。

/v1/0833a5737480d53b2f25c010dc1a7b88/data-connections/d06e52a4eb884b5c942b22d98b5947f8

{
  "mode" : 0,
  "data_source_vos" : [ {
    "dw_config" : {
      "clusterId" : "353ff458-a560-413e-9b84-33f930cb8057",
      "clusterName" : "mrs_3x_autotest_do_not_del",
      "dbUserName" : "xxxxxx",
      "dbPassword" : "xxxxxx",
      "kmsId" : "a721616c-9a12-47b1-a805-3cfcd3e63cd7",
      "kmsName" : "KMS-1111",
      "mrsConnectionType" : "agent"
    },
    "dw_type" : "HBASE",
    "dw_name" : "test_hbase_01",
    "agent_id" : "91f81a12-75c5-43ce-aab8-7149ecef3b17",
    "agent_name" : "cdm-4autotest-nodelete",
    "create_user" : "",
    "create_time" : 1606879861750,
    "qualified_name" : "hive@192.168.0.4-dayu_cdc_w00591497.62099355b894428e8916573ae635f1f9-workspace-e96e2cddce4340acb61591f8f570059d",
    "description" : "样例参数",
    "dw_category" : "test"
  } ]
}

更新RDS MySQL类型的数据连接。

/v1/0833a5737480d53b2f25c010dc1a7b88/data-connections/d06e52a4eb884b5c942b22d98b5947f8

{
  "mode" : 0,
  "data_source_vos" : [ {
    "dw_config" : {
      "dbDriverName" : "com.mysql.jdbc.Driver",
      "configStorageType" : "USER_OBS",
      "driverPath" : "obs://obsbucket/driver/mysql-connector-java-5.1.44.jar",
      "ip" : "192.168.1.174",
      "port" : "3306",
      "dbUserName" : "********",
      "dbPassword" : "********",
      "kmsId" : "2d921482-bece-4183-b332-11ce324510e8",
      "kmsName" : "evs/default",
      "kmsSpec" : "AES_256",
      "cdmPropertyEnable" : false,
      "metadata.enableRealtimeSync" : false,
      "metadata.enableAutoCollection" : false
    },
    "dw_type" : "RDS",
    "dw_name" : "rds_mysql_connection",
    "agent_id" : "fbc429c3-3952-4b99-af17-d043b7216000",
    "agent_name" : "cdm-y60071169",
    "support_service" : 12,
    "create_user" : "",
    "create_time" : 1777777666666
  } ],
  "visible" : 1
}

响应示例

状态码：200

Success，数据连接信息更新成功。

{
  "is_success" : true,
  "message" : null
}

状态码：400

BadRequest。

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed， detail msg {0}."
}

状态码：500

Internal Server Error。

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

SDK代码示例

SDK代码示例如下。

更新MRS HBASE类型的数据连接。

     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.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateDataconnectionSolution {

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

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateDataconnectionRequest request = new UpdateDataconnectionRequest();
        request.withDataConnectionId("{data_connection_id}");
        ApigDataSourcesVo body = new ApigDataSourcesVo();
        List<ApigDataSourceVo> listbodyDataSourceVos = new ArrayList<>();
        listbodyDataSourceVos.add(
            new ApigDataSourceVo()
                .withDwName("test_hbase_01")
                .withDwType("HBASE")
                .withDwConfig("{\"mrsConnectionType\":\"agent\",\"clusterName\":\"mrs_3x_autotest_do_not_del\",\"kmsName\":\"KMS-1111\",\"clusterId\":\"353ff458-a560-413e-9b84-33f930cb8057\",\"kmsId\":\"a721616c-9a12-47b1-a805-3cfcd3e63cd7\",\"dbUserName\":\"xxxxxx\",\"dbPassword\":\"xxxxxx\"}")
                .withAgentId("91f81a12-75c5-43ce-aab8-7149ecef3b17")
                .withAgentName("cdm-4autotest-nodelete")
                .withDwCategory("test")
                .withDescription("样例参数")
        );
        body.withDataSourceVos(listbodyDataSourceVos);
        body.withMode(0);
        request.withBody(body);
        try {
            UpdateDataconnectionResponse response = client.updateDataconnection(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());
        }
    }
}
 
 
  

更新RDS MySQL类型的数据连接。

     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.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateDataconnectionSolution {

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

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateDataconnectionRequest request = new UpdateDataconnectionRequest();
        request.withDataConnectionId("{data_connection_id}");
        ApigDataSourcesVo body = new ApigDataSourcesVo();
        List<ApigDataSourceVo> listbodyDataSourceVos = new ArrayList<>();
        listbodyDataSourceVos.add(
            new ApigDataSourceVo()
                .withDwName("rds_mysql_connection")
                .withDwType("RDS")
                .withDwConfig("{\"driverPath\":\"obs://obsbucket/driver/mysql-connector-java-5.1.44.jar\",\"ip\":\"192.168.1.174\",\"kmsName\":\"evs/default\",\"dbUserName\":\"********\",\"metadata.enableAutoCollection\":false,\"configStorageType\":\"USER_OBS\",\"metadata.enableRealtimeSync\":false,\"port\":\"3306\",\"cdmPropertyEnable\":false,\"kmsSpec\":\"AES_256\",\"kmsId\":\"2d921482-bece-4183-b332-11ce324510e8\",\"dbDriverName\":\"com.mysql.jdbc.Driver\",\"dbPassword\":\"********\"}")
                .withAgentId("fbc429c3-3952-4b99-af17-d043b7216000")
                .withAgentName("cdm-y60071169")
        );
        body.withDataSourceVos(listbodyDataSourceVos);
        body.withVisible(1);
        body.withMode(0);
        request.withBody(body);
        try {
            UpdateDataconnectionResponse response = client.updateDataconnection(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());
        }
    }
}
 
 
  

更新MRS HBASE类型的数据连接。

     # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 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 = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateDataconnectionRequest()
        request.data_connection_id = "{data_connection_id}"
        listDataSourceVosbody = [
            ApigDataSourceVo(
                dw_name="test_hbase_01",
                dw_type="HBASE",
                dw_config="{\"mrsConnectionType\":\"agent\",\"clusterName\":\"mrs_3x_autotest_do_not_del\",\"kmsName\":\"KMS-1111\",\"clusterId\":\"353ff458-a560-413e-9b84-33f930cb8057\",\"kmsId\":\"a721616c-9a12-47b1-a805-3cfcd3e63cd7\",\"dbUserName\":\"xxxxxx\",\"dbPassword\":\"xxxxxx\"}",
                agent_id="91f81a12-75c5-43ce-aab8-7149ecef3b17",
                agent_name="cdm-4autotest-nodelete",
                dw_category="test",
                description="样例参数"
            )
        ]
        request.body = ApigDataSourcesVo(
            data_source_vos=listDataSourceVosbody,
            mode=0
        )
        response = client.update_dataconnection(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 
 
  

更新RDS MySQL类型的数据连接。

     # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 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 = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateDataconnectionRequest()
        request.data_connection_id = "{data_connection_id}"
        listDataSourceVosbody = [
            ApigDataSourceVo(
                dw_name="rds_mysql_connection",
                dw_type="RDS",
                dw_config="{\"driverPath\":\"obs://obsbucket/driver/mysql-connector-java-5.1.44.jar\",\"ip\":\"192.168.1.174\",\"kmsName\":\"evs/default\",\"dbUserName\":\"********\",\"metadata.enableAutoCollection\":false,\"configStorageType\":\"USER_OBS\",\"metadata.enableRealtimeSync\":false,\"port\":\"3306\",\"cdmPropertyEnable\":false,\"kmsSpec\":\"AES_256\",\"kmsId\":\"2d921482-bece-4183-b332-11ce324510e8\",\"dbDriverName\":\"com.mysql.jdbc.Driver\",\"dbPassword\":\"********\"}",
                agent_id="fbc429c3-3952-4b99-af17-d043b7216000",
                agent_name="cdm-y60071169"
            )
        ]
        request.body = ApigDataSourcesVo(
            data_source_vos=listDataSourceVosbody,
            visible=1,
            mode=0
        )
        response = client.update_dataconnection(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 
 
  

更新MRS HBASE类型的数据连接。

     package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/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 := dataartsstudio.DataArtsStudioClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dataartsstudio.NewDataArtsStudioClient(hcClient)

    request := &model.UpdateDataconnectionRequest{}
	request.DataConnectionId = "{data_connection_id}"
	dwConfigDataSourceVos:= "{\"mrsConnectionType\":\"agent\",\"clusterName\":\"mrs_3x_autotest_do_not_del\",\"kmsName\":\"KMS-1111\",\"clusterId\":\"353ff458-a560-413e-9b84-33f930cb8057\",\"kmsId\":\"a721616c-9a12-47b1-a805-3cfcd3e63cd7\",\"dbUserName\":\"xxxxxx\",\"dbPassword\":\"xxxxxx\"}"
	var dwConfigDataSourceVosInterface interface{} = dwConfigDataSourceVos
	agentIdDataSourceVos:= "91f81a12-75c5-43ce-aab8-7149ecef3b17"
	agentNameDataSourceVos:= "cdm-4autotest-nodelete"
	dwCategoryDataSourceVos:= "test"
	descriptionDataSourceVos:= "样例参数"
	var listDataSourceVosbody = []model.ApigDataSourceVo{
        {
            DwName: "test_hbase_01",
            DwType: "HBASE",
            DwConfig: &dwConfigDataSourceVosInterface,
            AgentId: &agentIdDataSourceVos,
            AgentName: &agentNameDataSourceVos,
            DwCategory: &dwCategoryDataSourceVos,
            Description: &descriptionDataSourceVos,
        },
    }
	modeApigDataSourcesVo:= int32(0)
	request.Body = &model.ApigDataSourcesVo{
		DataSourceVos: &listDataSourceVosbody,
		Mode: &modeApigDataSourcesVo,
	}
	response, err := client.UpdateDataconnection(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
 
 
  

更新RDS MySQL类型的数据连接。

     package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/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 := dataartsstudio.DataArtsStudioClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dataartsstudio.NewDataArtsStudioClient(hcClient)

    request := &model.UpdateDataconnectionRequest{}
	request.DataConnectionId = "{data_connection_id}"
	dwConfigDataSourceVos:= "{\"driverPath\":\"obs://obsbucket/driver/mysql-connector-java-5.1.44.jar\",\"ip\":\"192.168.1.174\",\"kmsName\":\"evs/default\",\"dbUserName\":\"********\",\"metadata.enableAutoCollection\":false,\"configStorageType\":\"USER_OBS\",\"metadata.enableRealtimeSync\":false,\"port\":\"3306\",\"cdmPropertyEnable\":false,\"kmsSpec\":\"AES_256\",\"kmsId\":\"2d921482-bece-4183-b332-11ce324510e8\",\"dbDriverName\":\"com.mysql.jdbc.Driver\",\"dbPassword\":\"********\"}"
	var dwConfigDataSourceVosInterface interface{} = dwConfigDataSourceVos
	agentIdDataSourceVos:= "fbc429c3-3952-4b99-af17-d043b7216000"
	agentNameDataSourceVos:= "cdm-y60071169"
	var listDataSourceVosbody = []model.ApigDataSourceVo{
        {
            DwName: "rds_mysql_connection",
            DwType: "RDS",
            DwConfig: &dwConfigDataSourceVosInterface,
            AgentId: &agentIdDataSourceVos,
            AgentName: &agentNameDataSourceVos,
        },
    }
	visibleApigDataSourcesVo:= int32(1)
	modeApigDataSourcesVo:= int32(0)
	request.Body = &model.ApigDataSourcesVo{
		DataSourceVos: &listDataSourceVosbody,
		Visible: &visibleApigDataSourcesVo,
		Mode: &modeApigDataSourcesVo,
	}
	response, err := client.UpdateDataconnection(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
 
 
  