Updated on 2024-04-18 GMT+08:00

Creating a Data Source

Function

This API is used to create a data source.

Call Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/ext-data-sources
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the ID, see Obtaining the Cluster ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

data_source_id

No

String

Data source ID This parameter is mandatory when the data source is MRS.

type

Yes

String

Data source type. The options are as follows:

  • OBS
  • MRS

data_source_name

Yes

String

Data source name. The value can contain 1 to 64 characters, including uppercase letters, lowercase letters, numbers, and underscores (_).

user_name

Yes

String

Username The value can contain 2 to 20 characters, including uppercase letters, lowercase letters, numbers, and underscores (_).

If the data source is OBS, set this parameter to the OBS agency name.

user_pwd

No

String

Password This parameter is mandatory when the data source is MRS.

description

No

String

Description. A maximum of 256 characters, excluding <>'=&

reboot

No

Boolean

Whether to restart

connect_info

No

String

Connected database This parameter is mandatory when the data source is OBS.

Response Parameters

Table 3 Parameters in the response body

Parameter

Type

Description

id

String

Data source configuration ID

job_id

String

ID of the task for creating a data source.

Example Request

Create an OBS data source named test154 and set the username to DWSAccessOBS, and connect it to GaussDB:

POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/ext-data-sources
{
  "type": "OBS",
  "data_source_name": "test154",
  "user_name": "DWSAccessOBS",
  "connect_info": "gaussdb",
  "description": "xxx"
}

Example Response

Status code: 200

{
  "id" : "d303f19c-fbd1-4716-ae04-07d1ff358f22",
  "job_id" : "2c9081c88418ed420184197c8bc80001"
}

SDK Sample Code

The 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
50
51
52
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.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class CreateDataSourceSolution {

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

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        CreateDataSourceRequest request = new CreateDataSourceRequest();
        ExtDataSourceReq body = new ExtDataSourceReq();
        body.withConnectInfo("gaussdb");
        body.withDescription("xxx");
        body.withUserName("DWSAccessOBS");
        body.withDataSourceName("test154");
        body.withType("OBS");
        request.withBody(body);
        try {
            CreateDataSourceResponse response = client.createDataSource(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
34
35
36
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = CreateDataSourceRequest()
        request.body = ExtDataSourceReq(
            connect_info="gaussdb",
            description="xxx",
            user_name="DWSAccessOBS",
            data_source_name="test154",
            type="OBS"
        )
        response = client.create_data_source(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
40
41
42
43
44
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.CreateDataSourceRequest{}
	connectInfoExtDataSourceReq:= "gaussdb"
	descriptionExtDataSourceReq:= "xxx"
	request.Body = &model.ExtDataSourceReq{
		ConnectInfo: &connectInfoExtDataSourceReq,
		Description: &descriptionExtDataSourceReq,
		UserName: "DWSAccessOBS",
		DataSourceName: "test154",
		Type: "OBS",
	}
	response, err := client.CreateDataSource(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The data source is successfully created.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

The service was unavailable.