Updated on 2024-12-10 GMT+08:00

Updating a Data Connection

Function

This API is used to update 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

PUT /v2/{project_id}/data-connectors/{connector_id}

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

connector_id

Yes

String

Explanation

Data connection ID.

Constraints

N/A

Value range

The value can contain 0 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

data_connector

Yes

DataConnector 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: 200

Table 4 Response body parameter

Parameter

Type

Description

result

String

Explanation

Result of the request for updating a mapping.

Constraints

N/A

Value range

  • succeeded: The operation is successful.
  • failed: The operation failed.

Default value

N/A

Example Request

/v2/274ee662a7e24cc99bfc858c4558dbf6/data-connector/7d169c6c-ab50-4a56-a5d2-240ca20aabda

{
  "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: 200

Data connection updated.

{
  "result" : "succeed"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.