platform-bi-web/gitbook/dev/interface-dataConnect.md

接口设计 - 数据连接

新增数据连接配置

请求路径

/DataBase/inputDatabases

请求方式

HTTP - POST

请求参数

字段名	类型	说明
name	String	数据连接名
addrass	String	数据库地址
port	String	数据库端口
databaseType	String	数据库类型
dataName	String	数据库名
userName	String	用户名
passWord	String	密码
note	String	说明

请求示例

{
    "name": "test",
    "addrass": "192.168.253.6",
    "port": "1521",
    "databaseType": "oracle",
    "dataName": "orcl",
    "userName": "UAS",
    "passWord": "123456",
    "note": "说明"
}

返回结果

{
    "code": 200,
    "msg": "成功",
    "data": 83
}

详细说明

---

修改数据连接配置

请求路径

/DataBase/updatabases

请求方式

HTTP - POST

请求参数

字段名	类型	说明
id	Number	数据连接id
name	String	数据连接名
addrass	String	数据库地址
port	String	数据库端口
databaseType	String	数据库类型
dataName	String	数据库名
userName	String	用户名
passWord	String	密码
note	String	说明

请求示例

{
    "id": 83,
    "name": "test1",
    "addrass": "192.168.253.6",
    "port": "1521",
    "databaseType": "oracle",
    "dataName": "orcl",
    "userName": "UAS",
    "passWord": "123456",
    "note": "说明"
}

返回结果

{
    "code": 200,
    "msg": "成功",
    "data": null
}

详细说明

---

删除数据连接配置

请求路径

/DataBase/delDatabases

请求方式

HTTP - POST

请求参数

数据连接id

请求示例

83

返回结果

{
    "code": 200,
    "msg": "成功",
    "data": null
}

详细说明

---

获得数据连接列表

请求路径

/DataBase/getDatabases

请求方式

HTTP - POST

请求参数

空

返回结果

{
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "id": 62,
            "name": "UAS标准版",
            "addrass": "192.168.253.6",
            "port": "1521",
            "databaseType": "oracle",
            "dataName": "orcl",
            "userName": "UAS",
            "passWord": "",
            "note": "这个说明应该允许为空，如果是常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常常文本",
            "createDate": "2018-08-06 11:26:07.0",
            "updateDate": null
        },
        {
            "id": 55,
            "name": "华商龙",
            "addrass": "218.18.115.198",
            "port": "1521",
            "databaseType": "oracle",
            "dataName": "orcl",
            "userName": "N_WILIC",
            "passWord": "",
            "note": "华商龙",
            "createDate": "2018-08-01 16:11:24.0",
            "updateDate": null
        },
        {
            "id": 82,
            "name": "文档测试",
            "addrass": "192.168.253.6",
            "port": "1521",
            "databaseType": "oracle",
            "dataName": "orcl",
            "userName": "UAS",
            "passWord": "",
            "note": "61",
            "createDate": "2018-08-08 16:02:04.0",
            "updateDate": null
        }
    ]
}

详细说明

---

校验数据库连接是否合法

请求路径

/DataBase/testConnect

请求方式

HTTP - POST

请求参数

字段名	类型	说明
name	String	数据连接名
addrass	String	数据库地址
port	String	数据库端口
databaseType	String	数据库类型
dataName	String	数据库名
userName	String	用户名
passWord	String	密码

请求示例

{
    "name": "文档测试",
    "addrass": "192.168.253.6",
    "port": "1521",
    "databaseType": "oracle",
    "dataName": "orcl",
    "userName": "UAS",
    "passWord": "123456"
}

返回结果

测试通过

{
    "code": 200,
    "msg": "成功",
    "data": null
}

详细说明