数据源接口

数据源注册

接口地址:/api/v1/datasource

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "accelerationConfig": {},
  "connConfig": {},
  "desc": "",
  "metadataConfig": {},
  "name": "",
  "type": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	AddDataSourceRequest	AddDataSourceRequest
accelerationConfig	数据源加速数据更新配置		false	object
connConfig	数据源连接信息配置		false	object
desc	数据源描述		false	string
metadataConfig	数据源元数据同步配置		false	object
name	数据源名称		false	string
type	数据源类型		false	string

响应状态:

状态码	说明	schema
200	OK
404	未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

删除数据源配置

接口地址:/api/v1/datasource/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "datasourceGuid": "",
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
datasourceGuid	数据源guid		false	string

响应状态:

状态码	说明	schema
200	OK
404	未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

查看数据源表列表

接口地址:/api/v1/datasource/detail

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述: 查询数据源下某个schema下的表的列表

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
guid	schemaGuid e.g "catalog"."schema"	query	true	string
keyword	表名搜索关键词	query	false	string

响应状态:

状态码	说明	schema
200	OK
404	未找到资源

响应参数:

参数名称	参数说明	类型	schema
desc	表的描述	string
fileName	文件名(比如hdfs下有文件)	string
folderPath	文件夹/表的路径	array	Folder0
guid	表的guid"catalog"."schema"."table"	string
name	表名	string
gmtCreate	创建时间(13位毫秒级)	integer(int64)
ownerName	表的负责人	string
sourceType	数据源类型	string
type	元数据类型TALBE: 表FOLDER: 文件夹	string
path	文件路径（hdfs下文件的路径）
totalCount	表的总数量	integer(int64)	integer(int64)

响应示例:

{
  "data":{
    "dataList": [
        {
            "desc": "",
            "fileName": "",
            "folderPath": [
                {
                    "guid": "\"hdfs_test\"",
                    "name": "hdfs_test"
                },
                {
                    "guid":"\"hdfs_test\".\"data\"",
                    "name":"data"
                },
                {
                    "guid":"\"hdfs_test\".\"data\"",
                    "name":"data"
                },
                {
                    "guid":"\"hdfs_test\".\"data\".\"tardis\"",
                    "name":"tardis"
                }
            ],
            "gmtCreate": 0,
            "guid": "",
            "name": "",
            "ownerName": "",
            "path": "",
            "sourceType": "",
            "tableName": "",
            "type": "TABLE" 
        }
    ],
    "totalCount": 0 //表的数量
  },
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

获取数据源概览

接口地址:/api/v1/datasource/info

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
guid	表的guid"catalog"."schema"."table"	query	true	string

响应状态:

状态码	说明	schema
200	OK	DataSourceResponse
404	未找到资源

响应参数:

参数名称	参数说明	类型	schema
datasourceGuid	数据源guid"datasourceName"	string
gmtCreate	创建时间(13位毫秒级)	integer(int64)	integer(int64)
gmtModified	修改时间(13位毫秒级)	integer(int64)	integer(int64)
name	数据源名称	string
owner	数据源创建者	Object	User
type	数据源类型	string

响应示例:

{
  "data":{
    "datasourceGuid": "\"mysql\"",
    "gmtCreate": 0,
    "gmtModified": 0,
    "name": "",
    "owner": {
        "userId": "",
        "username": ""
    },
    "type": ""
  },
  "errorCode":"",
  "errorMsg":"",
  "success":true / false
}

获取数据源列表

接口地址:/api/v1/datasource/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

响应状态:

状态码	说明	schema
200	OK	DataSourceDTO
404	未找到资源

响应参数:

参数名称	参数说明	类型
dataSourceGuid	数据源Guid	String
name	数据源名称	String
owner	数据源负责人	Object，详见响应示例
type	数据源类型	String
gmtCreate	创建时间(13位毫秒级)	integer(int64)
gmtUpdate	更新时间(13位毫秒级)	integer(int64)

响应示例:

{
  "data":[{
    "dataSourceGuid":"",
    "name":"",
    "owner":{
      "userId":"",
      "username":""
    },
    "type":"",
    "gmtCreate":0,
    "gmtUpdate":0
  }],
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

刷新数据源目录

接口地址:/api/v1/datasource/refresh

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "guid": "\"sr_test1\"" 
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
guid	数据源guid		false	string

响应状态:

状态码	说明	schema
200	OK
404	未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":""
  "errorMsg":"",
  "success": true / false
}

查看数据源库表列表

接口地址:/api/v1/datasource/schema

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
guid	数据源guid	query	true	string

响应状态:

状态码	说明	schema
200	OK	SchemaDetailResponse
404	未找到资源

响应参数:

参数名称	参数说明	类型	schema
folderPath	schema路径	array
name	schema名称	string
gmtCreate	创建时间(13位毫秒级)	integer(int64)	integer(int64)
gmtModified	更新时间(13位毫秒级)	integer(int64)	integer(int64)
owner	负责人	Object详见响应示例
schemaGuid	"catalog"."schema"	string
type	文件夹FOLDER	string

响应示例:

{
  "data":[
    {
        "folderPath": [
            {
                "guid": "\"mysql\"",
                "name": "mysql"
            }
        ],
        "gmtCreate": 0,
        "gmtModified": 0,
        "name": "information_schema", // schema名称
        "owner": { //负责人
            "userId": "",
            "username": ""
        },
        "schemaGuid": "\"mysql\".\"information_schema\"",
        "type": "FOLDER" // FOLDER:文件夹
    }
  ],
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

修改数据源配置

接口地址:/api/v1/datasource/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "accelerationConfig": {},
  "connConfig": {},
  "datasourceGuid": "",
  "desc": "",
  "metadataConfig": {},
  "name": "",
  "overrideMode": "",
  "type": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
request	request	body	true	UpdateDataSourceRequest	UpdateDataSourceRequest
accelerationConfig	数据源加速数据更新配置		false	object
connConfig	数据源连接信息配置		false	object
datasourceGuid	数据源guid		false	string
desc	数据源描述		false	string
metadataConfig	数据源元数据同步配置		false	object
name	数据源名称		false	string
overrideMode	是否覆盖数据集的刷新配置		false	string
type	数据源类型		false	string

响应状态:

状态码	说明	schema
200	OK
404	未找到资源

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":""
  "errorMsg":"",
  "success": true / false
}