Creating a Data Source
Function
This API is used to create a data source.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/ext-data-sources
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| cluster_id | Yes | String | Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints The value must be a valid DWS cluster ID. Range It is a 36-digit UUID. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| data_source_id | No | String | Definition External data source ID. This parameter is mandatory when the data source is MRS. Range N/A |
| type | Yes | String | Definition Data source type. Range N/A |
| data_source_name | Yes | String | Definition Name of the external data source. Range The value can contain 1 to 64 characters. Only uppercase letters, lowercase letters, numbers, and underscores (_) are allowed. |
| user_name | Yes | String | Definition Username. If the data source is OBS, set this parameter to the OBS agency name. Range The value can contain 3 to 20 characters. Only uppercase letters, lowercase letters, numbers, and underscores (_) are allowed. |
| user_pwd | No | String | Definition Password. This parameter is mandatory when the data source is MRS. Range N/A |
| description | No | String | Definition Description. Range Characters excluding <>'=& Max. 256 characters |
| reboot | No | Boolean | Definition Whether to restart the cluster. Range N/A |
| connect_info | No | String | Definition Connected database. This parameter is mandatory when the data source is OBS. Range N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Data source ID. Range N/A |
| job_id | String | Definition ID of the task for creating a data source. Range N/A |
Example Requests
Create an OBS data source named source1 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" : "source1",
"user_name" : "DWSAccessOBS",
"connect_info" : "gaussdb",
"description" : "description"
} Example Responses
Status code: 200
Request submitted.
{
"id" : "d303f19c-fbd1-4716-ae04-07d1ff358f22",
"job_id" : "2c9081c88418ed420184197c8bc80001"
} SDK Sample Code
The SDK sample code is as follows.
Create an OBS data source named source1 and set the username to DWSAccessOBS, and connect it to GaussDB.
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.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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("<YOUR REGION>")) .build(); CreateDataSourceRequest request = new CreateDataSourceRequest(); request.withClusterId("{cluster_id}"); ExtDataSourceReq body = new ExtDataSourceReq(); body.withConnectInfo("gaussdb"); body.withDescription("description"); body.withUserName("DWSAccessOBS"); body.withDataSourceName("source1"); 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()); } } } |
Create an OBS data source named source1 and set the username to DWSAccessOBS, and connect it to GaussDB.
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 | # coding: utf-8 import os 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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateDataSourceRequest() request.cluster_id = "{cluster_id}" request.body = ExtDataSourceReq( connect_info="gaussdb", description="description", user_name="DWSAccessOBS", data_source_name="source1", 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) |
Create an OBS data source named source1 and set the username to DWSAccessOBS, and connect it to GaussDB.
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 | 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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dws.NewDwsClient( dws.DwsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateDataSourceRequest{} request.ClusterId = "{cluster_id}" connectInfoExtDataSourceReq:= "gaussdb" descriptionExtDataSourceReq:= "description" request.Body = &model.ExtDataSourceReq{ ConnectInfo: &connectInfoExtDataSourceReq, Description: &descriptionExtDataSourceReq, UserName: "DWSAccessOBS", DataSourceName: "source1", Type: "OBS", } response, err := client.CreateDataSource(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 | Request submitted. |
| 400 | Request error. |
| 401 | Authentication failed. |
| 403 | You do not have required permissions. |
| 404 | No resources found. |
| 500 | Internal server error. |
| 503 | Service unavailable. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot