cnId 描述

支持所有BI已支持的连接器类型，包括自定义连接器
以下只是一部分类型，若不在以下范围内，可以联系产研获取
mysql, sqlserver, postgresql, gaussdb, greenplum, oracle, cirrodata, presto, redshift, maxcompute, hana, teradata, transwarp, doris, select_db, starrocks, ads, clickhouse, bilibili_clickhouse, vertica, netsuite, hive, hive_kerberos, db2, gbase, hawq, realtime, tidb, informix, kylin, bilibili_kylin, spark, impala, sybase, bilibili_druid, mongodb, druid, ftp, universe, sapbw, dli, trino, dameng, snowflake, olap_clickhouse, access

authConfig

大部分数据账户连接方式有2种，传参是不一样的，JDBCUR少部分库还不支持，具体参考看BI页面设计

指定数据库，即connectionType=DATABASE

jdbcurl，即connectionType= JDBCURL
部分库的传参会有些不同，比如hive的kerberos认证、maxcompute等，建议使用这个参数前联系产研确认参数

下面列举部分库的authConfig示例
注：所有password字段，需要用base64加密

// connectionType=DATABASE
{
  "authConfig": {
    "connectionType": "DATABASE",
    host": "localhost",
    "user": "test",
    "password": "dGVzdA==",
    "database": "test",
    "port": "3306",
    "maxConnections": 10,
    "customDriverId": ""
  }
}

// connectionType=JDBCURL
{
  "authConfig": {
    "connectionType": "JDBCURL",
    "user": "user",
    "password": "cGFzc3dvcmQ=",
    "jdbcUrl": "jdbc:mysql://{host}:{port}/{database}",
    "maxConnections": 10,
    "customDriverId": ""
  }
}

// connectionType=DATABASE
{
  "authConfig": {
    "connectionType": "DATABASE",
    "host": "localhost",
    "database": "catlog",
    "schema": "schema",
    "user": "user",
    "port": "8080",
    "maxConnections": 10,
    "customDriverId": ""
  }
}
// connectionType=JDBCUR
{
  "authConfig": {
    "connectionType": "JDBCURL",
    "database": "catlog",
    "schema": "schema",
    "user": "user",
    "password": "",
    "jdbcUrl": "jdbc:trino://{host}:{port}/{catalog}/{schema}?param1=value1&param2=value2",
    "maxConnections": 10,
    "customDriverId": ""
  }
}

特殊参数：
● invisible，字段类型：Boolean
○ 若为true，则该数据账户不会在BI界面中展示，且其下的数据集均无法编辑和更新，数据集创建也只能通过接口创建
○ 若为false，等价于不传，无影响

请求参数

Header 参数

X-Auth-Token

string

个人Token

可选

Body 参数application/json

cnId

string

连接器类型

必需

name

string

名称

必需

uId

string

创建人id

可选

若不填，则默认取当前用户id

authConfig

object

必需

不同类型的连接器格式各不相同，可以去数据账户页面创建一次来获取参数格式

project

string

部分库会用到的参数

可选

示例

{
    "cnId": "string",
    "name": "string",
    "uId": "string",
    "authConfig": {},
    "project": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

result

string

必需

response

object

必需

acId

string

数据账户id

必需

domId

string

域id

必需

cnId

string

连接器类型

必需

name

string

名称

必需

uId

string

创建人id

必需

authConfig

object

连接信息

必需

error

object

错误信息

可选

status

number

错误码

必需

message

string

信息

必需

detail

object

详情

必需

示例

{
    "result": "ok",
    "response": {
        "acId": "b8f4d64cc650a4275937a291",
        "domId": "demo",
        "cnId": "mysql",
        "name": "sss",
        "uId": "b1766b1ac99bf4679a1bd762",
        "authConfig": {
            "connectionType": "DATABASE",
            "host": "localhost",
            "user": "test",
            "password": "dGVzdA==",
            "database": "test",
            "port": "3306",
            "useSSL": "false",
            "maxConnections": 10,
            "customDriverId": ""
        }
    }
}

创建数据账户

cnId 描述#

authConfig#

请求参数

示例代码

返回响应

cnId 描述

authConfig