Updated on 2025-11-18 GMT+08:00

Testing Data Connection Creation

Function

This API is used to test data connection creation.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/data-connections/validation

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

workspace

Yes

String

Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

dw_name

Yes

String

Data connection type, which is customized during connection creation and obtained from Querying the Data Connection List during connection editting.

dw_type

Yes

String

Data connection type, for example, DWS, DLI, Hive, RDS, or SparkSQL. You can view all data connection types on the console and obtain data connections from Data Connections.

dw_config

Yes

Object

Configuration items for the data connection. They vary depending on the connection type. You are advised to debug them on the console.

dw_category

No

String

Data connection label.

create_user

No

String

Data connection creator

create_time

No

Number

Data connection creation time, which is a timestamp

agent_id

No

String

CDM cluster ID. For details about how to obtain it, see Querying the Cluster List.

agent_name

No

String

Agent cluster name. For details about how to obtain it, see Querying the Cluster List

dw_id

No

String

Data connection ID, which can be obtained from ListDataconnections.xml.

qualified_name

No

String

Qualified data connection name

description

No

String

Data connection description.

env_type

No

Integer

Environment type. Value 0 indicates the development environment, and 1 indicates the production environment.

Response Parameters

Status code: 200

The data connection is created.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Returned error information.

error_code

String

Returned error code.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Returned error information.

error_code

String

Returned error code.

Example Requests

{
  "dw_config" : {
    "clusterId" : "353ff458-a560-413e-9b84-33f930cb8057",
    "clusterName" : "mrs_3x_autotest_do_not_del",
    "nsUserName" : "xxxx",
    "nsPassword" : "xxxx",
    "kmsId" : "a721616c-9a12-47b1-a805-3cfcd3e63cd7",
    "kmsName" : "KMS-1111"
  },
  "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",
  "env_type" : 0,
  "description" : "Sample Parameters",
  "dw_category" : "test"
}

Example Responses

Status code: 200

The data connection is created.

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

Status code: 400

Bad request.

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

Status code: 500

Internal server error.

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

SDK Sample Code

The SDK sample code is as follows.

 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
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.*;


public class DebugDataconnectionSolution {

    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();
        DebugDataconnectionRequest request = new DebugDataconnectionRequest();
        ApigDataSourceVo body = new ApigDataSourceVo();
        request.withBody(body);
        try {
            DebugDataconnectionResponse response = client.debugDataconnection(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());
        }
    }
}
 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
# 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 = DebugDataconnectionRequest()
        request.body = ApigDataSourceVo(
        )
        response = client.debug_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)
 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DebugDataconnectionRequest{}
	request.Body = &model.ApigDataSourceVo{
	}
	response, err := client.DebugDataconnection(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

200

The data connection is created.

400

Bad request.

500

Internal server error.