文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 数据源/ 数据源新增 - CreateDataConnection
更新时间:2025-11-25 GMT+08:00
分享

数据源新增 - CreateDataConnection

功能介绍

数据源新增。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v1/{project_id}/connections

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

参数解释:

工作空间ID。获取方法请参见获取工作空间ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

X-Auth-Token

String

参数解释:

用户Token。通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

数据源名称。

取值范围:

不涉及

description

String

参数解释:

数据源描述信息。

取值范围:

不涉及

type

String

参数解释:

数据源类型。

取值范围:

  • MySQL

  • DWS

  • PostgreSQL

  • OpenGauss

  • Doris

  • HIVE

  • ClickHouse

  • DLI

  • API

source

String

参数解释:

数据源来源。

取值范围:

  • rds:云服务RDS数据源

  • dws:DWS集群数据源

  • mrs:云服务MRS数据源

  • gaussdb:云服务GaussDB数据源

  • public:公网接入方式数据源

  • restapi:API数据源

  • dli:云服务DLI数据源

  • endpoint-service:终端节点服务接入方式数据源

server_list

String

参数解释:

集群模式。

取值范围:

不涉及

database_name

String

参数解释:

数据库名。

取值范围:

不涉及

host

String

参数解释:

域名。

取值范围:

不涉及

port

Integer

参数解释:

端口。

取值范围:

不涉及

user_name

String

参数解释:

用户名。

取值范围:

不涉及

password

String

参数解释:

密码。

取值范围:

不涉及

trino_catalog

String

参数解释:

trino数据源Catalog

取值范围:

不涉及

trino_schema

String

参数解释:

trino数据源Schema

取值范围:

不涉及

region_id

String

参数解释:

当前region的ID。

取值范围:

不涉及

vpc_connection_id

String

参数解释:

vpc连接实例ID。

取值范围:

不涉及

cluster

ClusterInfoDTO object

云实例接入方式时必填。

config

DcConfigDTO object

配置参数。

表4 ClusterInfoDTO

参数

是否必选

参数类型

描述

id

String

参数解释:

关联云实例ID。

取值范围:

不涉及

表5 DcConfigDTO

参数

是否必选

参数类型

描述

ssl

Boolean

参数解释:

ssl参数配置。

取值范围:

不涉及

region_id

String

参数解释:

归属regionId;当前不支持跨region,值只能是当前regionId。

取值范围:

不涉及

catalog_name

String

参数解释:

数据目录名称。

取值范围:

dli:DLI自有catalog值为dli

catalog_type

String

参数解释:

数据目录类型。

取值范围:

  • dli:DLI自有catalog

  • lakeformation:lakeformation的数据目录

ds_project_id

String

参数解释:

队列归属projectId。

取值范围:

不涉及

queue_name

String

参数解释:

SQL队列。

取值范围:

不涉及

auth_type

String

参数解释:

验证方式。

取值范围:

AKSK

ds_ak

String

参数解释:

用户ak。

取值范围:

不涉及

ds_sk

String

参数解释:

用户sk。

取值范围:

不涉及

time_out

Integer

参数解释:

请求超时时间。

取值范围:

不涉及

protocol

String

参数解释:

协议。

取值范围:

不涉及

token_key

String

参数解释:

token key。

取值范围:

不涉及

token_value

String

参数解释:

token value。

取值范围:

不涉及

request_url

String

参数解释:

请求url。

取值范围:

不涉及

request_method

String

参数解释:

请求方式

取值范围:

不涉及

request_params

Array of RequestParamDto objects

请求参数列表。

resp_param

Array of ResponseParamDto objects

返回参数。

表6 RequestParamDto

参数

是否必选

参数类型

描述

location

String

参数解释:

位置。

取值范围:

不涉及

value

Array of strings

参数解释:

参数值。

取值范围:

不涉及

tag_id

String

参数解释:

标签ID。

取值范围:

不涉及

param_name

String

参数解释:

参数名称。

取值范围:

不涉及

alias_name

String

参数解释:

参数别名。

取值范围:

不涉及

field_type

String

参数解释:

参数类型

取值范围:

  • String:字符

  • Long:长整型

  • Decimal:数字

  • List<String>:字符串列表

  • List<Long>:长整型列表

  • List<Decimal>:数字列表

  • DateTime:日期时间

  • Bool:布尔

  • PageIndex:页码

  • PageNum:页大小

param_source

String

参数解释:

参数来源

取值范围:

  • custom:自定义用户

  • user:用户

  • userGroup:用户组

type

Boolean

参数解释:

是否加密。

取值范围:

不涉及

表7 ResponseParamDto

参数

是否必选

参数类型

描述

alias_name

String

参数解释:

参数别名。

取值范围:

不涉及

field_type

String

参数解释:

参数类型。

取值范围:

  • String:字符

  • Long:长整型

  • Decimal:数字

  • DateTime:日期时间

  • Bool:布尔

param_name

String

参数解释:

参数名称。

取值范围:

不涉及

响应参数

状态码:200

表8 响应Body参数

参数

参数类型

描述

message

String

参数解释:

描述。

取值范围:

不涉及

请求示例

数据源新增。

POST /v1/{project_id}/connections

1.新增公网连接类型数据源
{
  "name": "dws02",
  "server_list": "xx.xx.x.xx:xxxx",
  "database_name": "gaussdb",
  "user_name": "xxxxx",
  "password": "xxxxxxx",
  "config": {
    "ssl": true
  },
  "source": "public",
  "type": "DWS"
}

2.新增DWS云数据源
{
    "name": "dws04_instance",
    "description": "测试新增",
    "source": "dws",
    "type": "DWS",
    "database_name": "xxxxx",
    "user_name": "xxxx",
    "password": "xxxx",
    "region_id": "cn-north-7",
    "cluster": {
        "id": "xxxxxxxxxxxx"
    },
    "config": {
        "ssl": false
    }
}

3.新增RDS的MySQL云数据源
{
    "name": "mysql_instance",
    "description": "测试新增",
    "source": "rds",
    "type": "MySQL",
    "database_name": "xxxxx",
    "user_name": "xxxxx",
    "password": "xxxxx",
    "region_id": "cn-north-7",
    "cluster": {
        "id": "xxxxxxxxxxxx"
    },
    "config": {
        "ssl": false
    }
}

4.新增GaussDBForMySQL云数据源

{
    "name": "gaussdb_mysql_instance",
    "description": "测试新增",
    "source": "gaussdb",
    "type": "MySQL",
    "database_name": "xxxxx",
    "user_name": "xxxxx",
    "password": "xxxxx",
    "region_id": "cn-north-7",
    "cluster": {
        "id": "xxxxxxxx"
    },
    "config": {
        "ssl": false
    }
}

5.新增OpenGauss云数据源

{
    "name": "gaussdb_instance",
    "description": "测试新增",
    "source": "gaussdb",
    "type": "OpenGauss",
    "database_name": "xxxxx",
    "user_name": "xxxxx",
    "password": "xxxxx",
    "region_id": "cn-north-7",
    "cluster": {
        "id": "xxxxxxxx"
    },
    "config": {
        "ssl": false
    }
}

6.新增PostgreSQL云数据源
{
    "name": "postgre_instance",
    "description": "测试新增",
    "source": "rds",
    "type": "PostgreSQL",
    "database_name": "xxxxx",
    "user_name": "xxxxx",
    "password": "xxxxx",
    "region_id": "cn-north-7",
    "cluster": {
        "id": "xxxxxxxx"
    },
    "config": {
        "ssl": false
    }
}

响应示例

状态码:200

数据源新增成功。

{
  "message" : "xxxxxxxeac2af4e738e2430bb44xxxxxxx"
}

状态码

状态码

描述

200

数据源新增成功。

错误码

请参见错误码

相关文档