Skip to content

datasource manage

Jump to bottom
qifeng dai edited this page Jun 13, 2017 · 23 revisions

1.新增数据源

说明：项目有 "修改权限或项目所有者" 能够新增数据源。数据源若存在，则新增失败。

POST	/projects/:project-name/datasources/:datasource-name
Parameters: desc={desc}&type={type}&parameter={parameter}

Response:
Status: 201 Created
{
  "name": "bdi_db",
  "type": "MYSQL",
  "desc": "bdi 数据库",
  "parameter": {
      "address":"jdbc:mysql://172.18.1.22:3306",
      "database":"test",
      "user":"root",
      "password":"123456"
    }, 
  "createTime": 1468391778000,
  "modifyTime": 1468391778000,
  "projectName":"bdi",
  "owner": "bdi_user"
}

请求参数：

参数 类型 是否必选 描述 说明
desc string 否 描述 对数据源的简单描述
type enum 是 数据源类型 当前支持类型参看：[[数据源描述
parameter jsonObject 是 数据源的详细连接地址

2.修改并创建数据源

说明：项目有 "修改权限或项目所有者" 可以修改数据源。为方便使用，修改数据源时不支持修改数据源名，不支持修改数据源类型。数据源若不存在，则会新增。

PUT	/projects/:project-name/datasources/:datasource-name

Response:
Status: 200 OK

请求和返回同上。

3.修改数据源

说明：项目有 "修改权限或项目所有者" 可以修改数据源。为方便使用，修改数据源时不支持修改数据源名，不支持修改数据源类型。数据源若不存在，则修改失败。

PATCH	/projects/:project-name/datasources/:datasource-name

Response:
Status: 200 OK

请求说明：所有参数都是可选的。

请求和返回同上。

4.测试数据源的连接状态

说明：测试某个数据源是否正常连接。注意，这里没有项目信息。

GET	/datasources/test
Parameters: type={type}&parameter={parameter}

Response:
Status: 200 OK
{
  "status": 0, # 0 is Connected
  "message": "error message, if status is not 0"
}

返回参数：

参数 类型 是否必选 描述 说明
status int 是 连通状态 0 表示连通，否则表示不连通
message string 否 错误原因 当 status 不为 0 时，显示错误原因

5.删除数据源

说明：项目有修改权限或项目所有者可以删除数据源。

DELETE	/projects/:project-name/datasources/:datasource-name

Response:
Status: 200 OK

6.查看数据源

说明：项目有 "查看权限或项目所有者" 可以查看数据源。

GET	/projects/:project-name/datasources

Response:
Status: 200 OK
[
  {
    "name": "bdi_db",
    "type": "MYSQL",
    "desc": "bdi 数据库",
    "parameter": {
      "address":"jdbc:mysql://172.18.1.22:3306",
      "database":"test",
      "user":"root",
      "password":"123456"
    }, 
    "createTime": 1468391778000,
    "modifyTime": 1468391778000,
    "projectName":"bdi",
    "owner": "bdi_user"
  }
]

7.查看具体某个数据源

说明：项目有 "查看权限或项目所有者" 可以查看数据源。

GET	/projects/:project-name/datasources/:datasource-name

Response:
Status: 200 OK
[
  {
    "name": "bdi_db",
    "type": "MYSQL",
    "desc": "bdi 数据库",
    "parameter": {
      "address":"jdbc:mysql://172.18.1.22:3306",
      "database":"test",
      "user":"root",
      "password":"123456"
    }, 
    "createTime": 1468391778000,
    "modifyTime": 1468391778000,
    "projectName":"bdi",
    "owner": "bdi_user"
  }
]
Clone this wiki locally