数据空间接口

获取数据Catalog

接口地址:/api/v1/catalog

请求方式:GET

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

响应数据类型:*/*

接口描述:

请求参数:

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

响应状态:

状态码	说明	schema
200	OK	数据空间列表
404	未找到资源

响应参数:

参数名称	参数说明	类型	schema
gmtCreate	创建人时间(13位到毫秒)	integer(int64)	integer(int64)
gmtModified	更新时间(13位到毫秒)	integer(int64)	integer(int64)
name	数据空间名称	string
namespaceGuid	数据空间guid	string
owner	负责人	Object详见响应示例

响应示例:

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

创建数据Catalog

接口地址:/api/v1/catalog/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "name": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
name	名称	body	true	string

响应状态:

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

响应参数:

暂无

响应示例:

{
  "data":null,
  "errorCode":"xxx",
  "errorMsg":""
}

删除数据Catalog

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

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "guid": "\"catalogName\""
}

请求参数:

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

响应状态:

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

响应参数:

暂无

响应示例:

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

获取数据Catalog详情

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

请求参数:

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

响应状态:

状态码	说明	schema
200	OK	数据空间详情
404	未找到资源

响应参数:

参数名称	参数说明	类型	schema
name	数据空间名称	string
gmtCreate	创建时间(13位到毫秒)	integer(int64)	integer(int64)
gmtModified	更新时间(13位到毫秒)	integer(int64)	integer(int64)
namespaceGuid	数据空间guid	string
owner	负责人	Object详见示例

响应示例:

{
  "data":{
    "gmtCreate": 0,
    "gmtModified": 0,
    "name": "",
    "namespaceGuid": "",
    "owner": {
        "userId": "",
        "username": ""
    }
  },
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

查询数据Schema列表

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

请求方式:GET

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

响应数据类型:*/*

接口描述:

请求参数:

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

响应状态:

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

响应参数:

参数名称	参数说明	类型	schema
folderPath		array	Folder
name	数据空间名称	string
gmtCreate	创建时间(13位到毫秒)	integer(int64)	integer(int64)
gmtModified	更新时间(13位到毫秒)	integer(int64)	integer(int64)
owner	负责人	Object详见响应示例	SimpleUserResponse
schemaGuid	schemaGuid"catalog"."schema"	string
type	类型：FOLDER	string

响应示例:

{
  "data":[
    {
        "folderPath": [
            {
                "guid": "\"demo\"",
                "name": "demo"
            }
        ],
        "gmtCreate": 0,
        "gmtModified": 0,
        "name": "",
        "owner": {
            "userId": "",
            "username": ""
        },
        "schemaGuid": "\"demo\".\"schema\"",
        "type": "FOLDER"
    }
  ],
  "errorCode":"",
  "errorMsg":"",
  "success": false / true 
}

创建数据Schema

接口地址:/api/v1/catalog/schema/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述: 创建数据空间下的schema,目前仅支持创建一层

请求示例:

{
  "guid": "\"catalogName\"",
  "name": "schema名称"
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
guid	数据空间guid	body	true	string
name	schema名称	body	true	string

响应状态:

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

响应参数:

暂无

响应示例:

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

删除数据Schema

接口地址:/api/v1/catalog/schema/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "guid": "\"catalog\".\"schemaName\""
}

请求参数:

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

响应状态:

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

响应参数:

暂无

响应示例:

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

查询数据Schema树结构

接口地址:/api/v1/catalog/search

请求方式:GET

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

响应数据类型:*/*

接口描述:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
keyword	schema名称关键词	query	true	string

响应状态:

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

响应参数:

参数名称	参数说明	类型	schema
children		array	SubTree
guid	数据空间guid	string
name	数据空间名称	string

响应示例:

{
  "data":[
    {
        "children": [
            {
                "catalogName": "xingye",
                "children": [],
                "guid": "\"xingye\".\"test\"",
                "name": "test",
                "path": ["schemaName"],
                "type": "FOLDER"
            }
        ],
        "guid": "\"xingye\"",
        "name": "xingye"
    }
  ],
  "errorCode":"",
  "errorMsg":"",
  "success": true / false
}

查询数据空间下的schema列表或者schema下的视图列表

接口地址:/api/v1/catalog/view

请求方式:GET

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

响应数据类型:*/*

接口描述: 查询数据空间下的schema列表或者schema下的视图列表

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
guid	guid	query	true	string
keyword	关键词	query	false	string

响应状态:

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

响应参数:

参数名称	参数说明	类型	schema
dataList		array
totalCount		integer(int64)	integer(int64)

响应示例:

{
    "dataList": [
        {
            //如果是查询schema列表：\"demo\".\"demo\" 如果是表的列表：
            "datasetGuid": "",
            "folderPath": [
                {
                    "guid": "",
                    "name": ""
                }
            ],
            "gmtCreate": 0,
            "gmtModified": 0,
            "name": "schema名称或者视图名称",
            "owner": {
                "userId": "",
                "username": ""
            },
            // 如果是参数化视图判断逻辑 VIEW + parametricView = true
            "parametricView": true,
            "type": "FOLDER/VIEW/DIALECT_VIEW/INTERNAL_TABLE/PARTITION_VIEW"
        }
    ],
    "totalCount": 0
}