Creating a Data Connection - CreateDataConnector
Function
This API is used to create an external data connection for an MRS cluster.
MRS provides a data connection management feature that supports storing the metadata of cluster components (such as Hive and Ranger) in an external data source, achieving decoupling from the data storage layer (such as HDFS) and compute engines (such as Spark and Flink).
Constraints
None
Debugging
You can debug this API in API Explorer, which supports automatic authentication and authorization. API Explorer can automatically generate sample SDK code and supports sample SDK code debugging.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependency
mrs:dataConnector:updateInstance
Write
-
-
-
-
URI
POST /v2/{project_id}/data-connectors
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints The value can contain 1 to 64 characters. Only letters and digits are allowed. Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| data_connector | Yes | object | Definition Data connection. For details, see Table 3. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| connector_name | Yes | String | Definition Data connection name. Constraints N/A Range N/A Default Value N/A |
| source_type | Yes | String | Definition Data connection type. Constraints N/A Range
Default Value N/A |
| source_info | Yes | String | Definition Data source information, which is in JSON format. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 201
| Parameter | Type | Description |
|---|---|---|
| connector_id | String | Definition Data connection ID returned after a data connection is created. Range N/A |
Example Request
Create a MySQL data connection.
POST https://{endpoint}/v2/df786bad0d21416c95d37937678d22d5/data-connectors
{
"data_connector" : {
"connector_name" : "mrs-mysql-connector",
"source_type" : "RDS_MYSQL",
"source_info" : "{\"db_name\":\"default\",\"user_name\":\"mrs\",\"password\":\"*****\",\"rds_instance_id\":\"3aa55f1cb4c3491686936130f21e9f16in01\"}"
}
} Example Response
Status code: 201
Data connection created successfully.
{
"connector_id" : "0822239c1e80d4502f82c008937da9b5"
} SDK Sample Code
The SDK sample code is as follows.
Create a MySQL data connection.
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 | 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.mrs.v2.region.MrsRegion; import com.huaweicloud.sdk.mrs.v2.*; import com.huaweicloud.sdk.mrs.v2.model.*; public class CreateDataConnectorSolution { 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); MrsClient client = MrsClient.newBuilder() .withCredential(auth) .withRegion(MrsRegion.valueOf("<YOUR REGION>")) .build(); CreateDataConnectorRequest request = new CreateDataConnectorRequest(); DataConnectorReq body = new DataConnectorReq(); DataConnector dataConnectorbody = new DataConnector(); dataConnectorbody.withConnectorName("mrs-mysql-connector") .withSourceType(DataConnector.SourceTypeEnum.fromValue("RDS_MYSQL")) .withSourceInfo("{"db_name":"default","user_name":"mrs","password":"*****","rds_instance_id":"3aa55f1cb4c3491686936130f21e9f16in01"}"); body.withDataConnector(dataConnectorbody); request.withBody(body); try { CreateDataConnectorResponse response = client.createDataConnector(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 a MySQL data connection.
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 huaweicloudsdkmrs.v2.region.mrs_region import MrsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmrs.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 = MrsClient.new_builder() \ .with_credentials(credentials) \ .with_region(MrsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateDataConnectorRequest() dataConnectorbody = DataConnector( connector_name="mrs-mysql-connector", source_type="RDS_MYSQL", source_info="{"db_name":"default","user_name":"mrs","password":"*****","rds_instance_id":"3aa55f1cb4c3491686936130f21e9f16in01"}" ) request.body = DataConnectorReq( data_connector=dataConnectorbody ) response = client.create_data_connector(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 a MySQL data connection.
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 56 57 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" mrs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/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 := mrs.MrsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := mrs.NewMrsClient(hcClient) request := &model.CreateDataConnectorRequest{} dataConnectorbody := &model.DataConnector{ ConnectorName: "mrs-mysql-connector", SourceType: model.GetDataConnectorSourceTypeEnum().RDS_MYSQL, SourceInfo: "{"db_name":"default","user_name":"mrs","password":"*****","rds_instance_id":"3aa55f1cb4c3491686936130f21e9f16in01"}", } request.Body = &model.DataConnectorReq{ DataConnector: dataConnectorbody, } response, err := client.CreateDataConnector(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
See Status Codes.
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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