Help Center/ MapReduce Service/ API Reference/ API V2/ Data Connection Management/ Creating a Data Connection
Updated on 2024-12-10 GMT+08:00
View PDF
Share

Creating a Data Connection

Function

This API is used to create a data connection.

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.

URI

POST /v2/{project_id}/data-connectors

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation

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

Constraints

N/A

Value range

The value must consist of 1 to 64 characters. Only letters and digits are allowed.

Default value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

data_connector

Yes

object

Explanation

Data connection. For details, see Table 3.

Constraints

N/A

Value range

N/A

Default value

N/A
Table 3 DataConnector

Parameter

Mandatory

Type

Description

connector_name

Yes

String

Explanation

Data connection name.

Constraints

N/A

Value range

N/A

Default value

N/A

source_type

Yes

String

Explanation

Data connection type.

Constraints

N/A

Value range

  • RDS_POSTGRES: RDS PostgreSQL database
  • RDS_MYSQL: RDS MySQL database
  • gaussdb-mysql: GaussDB(for MySQL)

Default value

N/A

source_info

Yes

String

Explanation

Data source information, which is in JSON format.

Constraints

N/A

Value range

N/A

Default value

N/A

Response Parameters

Status code: 201

Table 4 Response body parameter

Parameter

Type

Description

connector_id

String

Explanation

Data connection ID returned after a data connection is created.

Constraints

N/A

Value range

N/A

Default value

N/A

Example Request

Create a MySQL data connection.

/v2/ac66f1a5-e8f4-4399-8ec6-2c8cb1aefda7/data-connector

{
  "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"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.