数据源
更新时间：2025-08-22
创建数据源
接口简介
创建数据源
接口详情
请求地址
/openapi/v1/group/{groupKey}/database?__scp__={__scp__}
请求类型
POST
请求参数
Javascript
1{
2 database: "test", // 数据库名称
3 host: "123.0.0.1", // 数据库地址Host
4 name: "test", // 数据源名称
5 password: "root", // 密码
6 port: "3306", // 端口号
7 tunnelHash: 0, // 数据源名称
8 type: 0, // 使用内网隧道
9 username: "admin" // 用户名
10}| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
|---|---|---|---|---|---|
| name | String | 是 | 数据源名称 | - | 名称 |
| remark | String | 否 | 数据源描述 | - | 描述 |
| type | String | 是 | 数据源类型(详细描述见下方数据源描述) | 0 | 0 |
| host | String | 是 | 数据库地址 Host | - | 61.135.169.121 |
| port | String | 是 | 端口号 | - | 3306 |
| database | String | 是 | 数据库名称(Kylin 中是 project 项目/Cassandra 中是 Keyspace) | - | sugar |
| username | String | 是 | 用户名 | - | test |
| password | String | 是 | 密码 | - | test |
| excelData | String | 是 | 数据源名称 | - | test |
| config | String | 是 | 数据源其它配置信息(详细描述见下方) | - | - |
| tunnelHash | Number | 是 | 使用内网隧道 | 0 | 0 |
| tunnel_id | String | 是 | 数据源名称 | - | test |
数据源描述
| 数据源名称 | 数据源值 |
|---|---|
| MySQL 5.X | 0 |
| MySQL 8 | 20 |
| Apache Doris (Baidu Palo) | 1 |
| Baidu TSDB | 8 |
| MariaDB | 36 |
| PostgreSQL | 2 |
| Greenplum | 3 |
| SQL Server | 4 |
| Oracle | 5 |
| Redis | 16 |
| CockroachDB | 7 |
| IBM DB2 | 24 |
| SAP HANA | 6 |
| Apache Hive | 23 |
| Apache Kylin | 29 |
| Apache Impala | 35 |
| Apache Spark SQL | 37 |
| Apache Druid | 39 |
| TiDB | 18 |
| Cassandra | 17 |
| Clickhouse | 21 |
| Exasol | 33 |
| GBase | 32 |
| OpenTSDB | 13 |
| Prometheus | 14 |
| Graphite | 15 |
| Mongodb | 38 |
| Presto | 22 |
| Snowflake | 25 |
| Teradata | 31 |
| Vertica | 26 |
| ElasticSearch 6.3+ | 10 |
| ElasticSearch 1.x+（需装插件） | 12 |
| InfluxDB | 11 |
| JDBC 通用数据库 | 40 |
config 额外配置描述
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 | 适用数据库 |
|---|---|---|---|---|---|---|
| sqlServerVersion | String | 是 | SQL Server 版本 | 2012 | SQL Server 版本(详情信息见下方 SQL Server 版本) | SQL Server |
| jdbcURL | String | 是 | JDBC URL | - | - | Exasol、GBase、Apache Impala、Apache Druid、Snowflake、JDBC 通用数据库、Teradata |
| tsdbRegion | String | 是 | Baidu TSDB 数据库地域 | gz | 地域：gz 广州、bj 北京 | Baidu TSDB |
| localDataCenter | String | 否 | 本地数据中心地址 | - | - | Cassandra |
| hanaDatabase | String | 否 | SAP HANA 数据库名 | - | - | SAP HANA |
| esXpackPath | String | 否 | ElasticSearch 6.3+数据库地址 | /_xpack/sql?format=json | - | ElasticSearch 6.3+ |
| postgresqlSchema | String | 否 | schema 信息 | - | - | PostgreSQL、Greenplum、CockroachDB |
| sqlServerSchema | String | 否 | SQL Server 的 schema 信息 | dbo | - | SQL Server |
| orcaleSchema | String | 否 | Oracle 的 schema 信息 | - | - | Oracle |
| hanaSchema | String | 否 | hanaSchema 的 schema 信息 | - | - | SAP HANA |
| schema | String | 否（Presto 数据库时必填） | schema 信息 | - | - | Presto、IBM DB2、Vertica |
| authSource | String | 否 | Mongodb 的授权来源 | - | admin | Mongodb |
| mongoURL | String | 否 | Mongodb 的地址(填写 Mongo URI 会覆盖用户名等设置，使用方法请参考这里 | - | mongodb://{url} | Mongodb |
| ssl | boolean | 否 | 开启 ssl | - | true 开启、false 不开启 | PostgreSQL、Greenplum、CockroachDB |
| sslcert | String | 否 | 开启 ssl 后填写的 ssl cert | - | - | PostgreSQL、Greenplum、CockroachDB |
| sslkey | String | 否 | 开启 ssl 后填写的 ssl key | - | - | PostgreSQL、Greenplum、CockroachDB |
| sslrootcert | String | 否 | 开启 ssl 后填写的 ssl root cert | - | - | PostgreSQL、Greenplum、CockroachDB |
SQL Server 版本
| 版本 | 版本取值 |
|---|---|
| SQL Server 2012/2014/2016/2017 | 2012 |
| SQL Server 2008 R2 | 2008R2 |
| SQL Server 2008 | 2008 |
| SQL Server 2005 | 2005 |
| SQL Server 2000 | 2000 |
返回正确 JSON 示例
Javascript
1{
2 data: {},
3 msg: '',
4 status: 0
5}返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status: 499,
4 requestId: '',
5 code: 'NoSuchKey'
6}删除数据源
接口简介
删除数据源
接口详情
请求地址
/openapi/v1/group/{groupKey}/database/{databaseHash}?__scp__={__scp__}
请求类型
DELETE
请求参数
无
返回正确 JSON 示例
Javascript
1{
2 data: {},
3 msg: '',
4 status: 0
5}返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status: 499,
4 requestId: '',
5 code: 'NoSuchKey'
6}获取数据源列表
接口简介
获取数据源列表
接口详情
请求地址
/openapi/v1/group/{groupKey}/database?__scp__={__scp__}
请求类型
GET
请求参数
无
返回正确 JSON 示例
Javascript
1{
2 data: [ // 数据源列表
3 {
4 config: {
5 isDemoDb: true, // 是否是示例数据库
6 postgresqlSchema: "public", // schema信息
7 sqlServerSchema: "dbo" // SQL Server的schema信息
8 },
9 created_at: "2020-07-20T12:54:33.000Z", // 数据源创建时间
10 database: "sugarbi", // 数据库名称
11 hash: "d_sugar_example_database", // 数据源hash
12 host: "-", // host
13 name: "Sugar官方示例数据源", // 数据源名称
14 password: "******", // 密码
15 port: "3306", // 端口号
16 remark: "", // 数据源描述
17 type: 0, // 数据源类型
18 username: "root" // 用户名
19 }
20 ],
21 msg: '',
22 status: 0
23}返回错误 JSON 示例
Javascript
1{
2 msg: '错误详情',
3 status: 499,
4 requestId: '',
5 code: 'NoSuchKey'
6}