接口说明: 添加数据连接到指定项目

    权限说明: 使用 token 访问,只有项目管理员才能调用该接口。

    基本信息:

    属性
    API /api/dash/dataConnection/apiAdd
    Method POST

    请求参数:

    字段名称 参数类型 参数说明
    token String 鉴权 token,该用户必须是项目管理员
    name String 数据连接名称
    paths Arr(Optional) 文件夹路径,可以不传
    projectId Number 项目Id
    type Number 数据链接类型
    readOnly Number 是否只读。1-只读,0-非只读。默认为0

    请求参数:

    字段名称 参数类型 参数说明
    token String 鉴权 token,该用户必须是项目管理员
    name String 数据连接名称
    paths Arr(Optional) 文件夹路径,可以不传
    projectId Number 项目Id
    type Number 数据链接类型
    readOnly Number 是否只读。1-只读,0-非只读。默认为0

    输入参数举例

    MySQL:

    {
        "name": "测试MySQL",
        "projectId": 156,
        "type": 0,
        "paths": ["abc"],
        "server":"10.172.11.225",
        "port":"3306",
        "userName":"youdata",
        "password":"youdata",
        "defaultSchemaName": "BLD", // 默认database,可以不传
      "token": "1636597037183050570b9a6d51def260eea18"
    }

    Oracle:

    {
        "name": "测试Oracle",
        "projectId": 156,
        "type": 1,
        "paths": ["abc"],
        "server":"10.172.11.234",
        "port":"1521",
        "userName":"youdata",
        "password":"youdata",
        "parameters": {
            "SID": "XE"
        },
      "token": "1636597037183050570b9a6d51def260eea18"
    }

    SQL Server:

    {
        "name": "测试SQL Server",
        "projectId": 156,
        "type": 12,
        "paths": ["abc"],
        "server":"223.252.222.21",
        "port":"1433",
        "userName":"youdata",
        "password":"youdata",
        "namespace": ["test"], // 数据库
      "token": "1636597037183050570b9a6d51def260eea18"
    }

    Custom API:

    {
        "name": "测试 Custom API",
        "projectId": 156,
        "type": 24,
        "paths": ["abc"],
        "server":"url", // url地址
        "userName":"youdata",
        "password":"youdata",
        "parameters": {
            "customParameters": {
                // 查询参数配置
            }
        },
      "token": "1636597037183050570b9a6d51def260eea18"
    }

    Postgresql (PG)

    {
        "name": "测试pg",
        "projectId": 542,
        "type": 21,
        "paths": ["abc"],
        "server":"10.196.80.249",
        "port":"6432",
        "userName":"youdata_test",
        "password":"youdata",
        "namespace": ["youdata"],
      "token": "1636597037183050570b9a6d51def260eea18"
    }

    达梦

    {
        "name": "测试达梦",
        "projectId": 542,
        "type": 122,
        "paths": ["abc"],
        "server":"10.200.129.52",
        "port":"5236",
        "userName":"youdata",
        "password":"youdata",
      "token": "1636597037183050570b9a6d51def260eea18"
    }

    返回结果示例:

    {
        "code": 200,
        "result": {
            "server": "10.172.43.225",
            "port": 3306,
            "userName": "youdata",
            "password": null,
            "parameters": {},
            "name": "测试数据链接名称",
            "defaultSchemaName": "BLD",
            "type": 0,
            "modifiedId": 1,
            "available": 1,
            "dataConnectionInfo": {
                "version": "5.5.52-0+deb7u1"
            },
            "projectId": 156,
            "id": 3108,// 数据连接id
            "showname": "MySQL",
            "typeName": "mysql",
            "creatorName": "admin"
        },
        "logPath": "http://127.0.0.1:8009/operation/log/ut3j63gG1ga77PgQdCZN8C"
    }