更新时间:2024-11-29 GMT+08:00

创建数据连接

功能介绍

创建数据连接

URI

POST /v2/{project_id}/data-connectors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目编号。获取方法,请参见获取项目ID

约束限制:

不涉及

取值范围:

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

data_connector

object

参数解释:

数据连接,请参见表3

表3 DataConnector

参数

是否必选

参数类型

描述

connector_name

String

参数解释:

数据连接名称。

取值范围:

不涉及

source_type

String

参数解释:

数据连接类型。

取值范围:

  • RDS_POSTGRES:RDS服务PostgreSQL数据库
  • RDS_MYSQL:RDS服务MySQL数据库
  • gaussdb-mysql:云数据库GaussDB(for MySQL)

source_info

String

参数解释:

数据源信息,为json格式。

取值范围:

不涉及

响应参数

状态码:201

表4 响应Body参数

参数

参数类型

描述

connector_id

String

参数解释:

数据连接创建成功后系统返回的数据连接ID值。

取值范围:

不涉及

请求示例

创建mysql数据连接:

/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\"}"
  }
}

响应示例

状态码:201

数据连接创建成功

{
  "connector_id" : "0822239c1e80d4502f82c008937da9b5"
}

状态码

状态码请参见状态码

错误码

请参见错误码