元数据中心OpenAPI

此手册用于记录大数据开发与管理平台中，元数据中心产品所有对外开放的OpenAPI，阅读此手册，你将了解元数据中心产品开放的OpenAPI能力与调用方法。

一、公共参数

1.1 响应格式

1.2 错误码

1.2.1 公共错误码

详见OpenAPI通用规范说明

1.2.2 认证错误码

1.2.3 元数据中心内部错误码 (2000 - 2999)

1.2.4 子产品错误码 (3000 - 3999)

1.3 枚举列表

暂无

1.4 请求参数列表

1.4.1 基本参数

暂无

1.5 响应实体列表

1.5.1 基础实体

PageResult

分页查询结果

1.5.2 数据源

DatasourceInfo

数据源详情

DatasourceInfoDetail

数据源具体信息内容

1.5.3 Hive库结构

DatabaseInfo

1.5.4 Hive表结构

TableInfo

1.5.5 Hive字段结构

FieldInfo

1.5.6 Table血缘结构

LineageTableInfo

NextLineageTableInfo

NextLineageNode

1.5.7 Field血缘结构

LineageFieldInfo

NextLineageFieldInfo

1.5.8 公钥结构

KeyInfo

1.5.9 数据源登记Info

DatasourceInfo

登记格式参考：[登记数据源info格式说明]

主要字段说明：

二、OpenAPI列表

2.1 OpenAPI总览

2.2 数据源API

2.2.1 数据源详情获取

GET /datasource/v1/get

产品版本：v4.2.0 新增 v5.11.0 更新

描述：根据数据源id获取数据源详情信息

URL参数/请求体

请求示例（参数未编码，调用时请编码）：

product=testProduct&user=testUser@163.com&datasourceId=11

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": {

    // todo 待添加

    }

    "reqId": "b88d054742c04baea4cad4169be01daa",

    "cost": 21

}

2.2.2 数据源列表获取

GET /datasource/v1/list

产品版本：v4.2.0

描述：根据数据源类型，分页返回数据源列表，注意数据源列表以项目组粒度返回

URL参数/请求体

请求示例（参数未编码，调用时请编码）：

product=testProduct&email=testUser@163.com&datasourceType=mysql&pageNum=1&pageSize=10

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": {

        "pageNum": 1,

        "pageSize": 10,

        "totalCount": 23,

        "totalPage": 3,

        "list":\[

            // todo 待添加

        \]

    }

    "reqId": "b88d054742c04baea4cad4169be01daa",

    "cost": 21

}

2.2.3 数据源密码加密公钥获取

GET /datasource/v1/rsa/publickey/get

产品版本：v5.9.0

描述：获取数据源密码加密使用的RSA公钥

URL参数/请求体

无

响应体

响应示例

{

  "code": 0,

  "cost": 4,

  "reqId": "172a7050c56b9000",

  "result": {

    "publicKey": "asdasdbvaregqwgfqwrfeawefawefawefwefwfe"

  }

}

2.2.4 不带文件的数据源编辑

POST /datasource/v1/modify

产品版本：v5.9.0

描述：不带文件的数据源详情编辑。

不支持修改源系统账号映射状态（即不能从不开启转为开启，反之亦然）。

仅支持物理数据源的修改。

不支持修改数据源的使用授权。

不支持自定义模板中规定了必填字段的数据源

URL参数/请求体

响应体

响应示例

{

  "code": 0,

  "cost": 1232,

  "reqId": "172fcaafadaa3000",

  "result": true

}

2.2.5 带文件的数据源编辑

POST /datasource/v1/modifyForFile

产品版本：v5.9.0

描述：带文件的数据源详情编辑。

不支持修改源系统账号映射状态（即不能从不开启转为开启，反之亦然）。

仅支持物理数据源的修改。

不支持修改数据源的使用授权。

不支持自定义模板中规定了必填字段的数据源

URL参数/请求体

注：上传文件，multipartFiles采用multipart/form-data形式，基础信息将json转成字符串使用datasourceModifyParam作为key

响应体

响应示例

{

  "code": 0,

  "cost": 1232,

  "reqId": "172fcaafadaa3000",

  "result": true

}

2.2.6 数据源删除

POST /datasource/v1/delete

产品版本：v5.9.0

描述：删除数据源

URL参数/请求体

响应体

响应示例

{

  "code": 0,

  "cost": 1232,

  "reqId": "172fcaafadaa3000",

  "result": true

}

2.2.7 数据源所需文件下载

GET /datasource/v1/file/download

产品版本：v5.9.0

描述：下载登记时上传的数据源配置文件

URL参数/请求体

响应体

使用文件流接收，响应header为：

2.2.8 数据源密码解密

GET /datasource/v1/rsa/decrypt

产品版本：v5.9.0

描述：解密数据源密码的密文，生成明文

URL参数/请求体

响应体

响应示例

{

  "code": 0,

  "cost": 4,

  "reqId": "172a7050c56b9000",

  "result": "password"

}

2.2.9 不带文件的数据源登记

POST /datasource/v1/create

产品版本：v5.9.0

描述：不带文件的数据源详情登记。

仅支持物理数据源的登记。

不支持数据源自定义项中规定了必填字段的数据源。

不支持自定义参数填写。

使用授默认对项目组下所有项目授权。

按照用户需求，目前支持类型包括：

mysql,oracle,kafka,tidb,es,redis,postgresql,hiveExt

URL参数/请求体

响应体

响应示例

{

  "code": 0,

  "cost": 1232,

  "msg": null,

  "reqId": "172fcaafadaa3000",

  "result": 10001

}

2.2.10 带文件的数据源登记

POST /datasource/v1/createForFile

产品版本：v5.9.0

描述：带文件的数据源详情登记。

仅支持物理数据源的登记。

不支持数据源自定义项中规定了必填字段的数据源。

不支持自定义参数填写。

使用授默认对项目组下所有项目授权。

URL参数/请求体

注：上传文件，multipartFiles采用multipart/form-data形式，基础信息将json转成字符串使用datasourceCreateParamObj作为key

响应体

响应示例

{

  "code": 0,

  "cost": 1232,

  "msg": null,

  "reqId": "172fcaafadaa3000",

  "result": 111111

}

2.2.11 查看数据源版本

GET /datasource/v1/version/get

产品版本：v5.9.0

描述：查看数据源版本

按照用户需求，目前支持类型包括：

mysql,oracle,kafka,tidb,es,redis,postgresql,hiveExt

URL参数/请求体

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": \["5", "8"\]

    "reqId": "b88d054742c04baea4cad4169be01daa",

    "cost": 21

}

2.3 数据源库表列获取API（目前仅支持Hive）

2.3.1 数据源库列表获取

GET /database/v1/list

产品版本：v4.9.0

描述：获取某数据源database信息

URL参数/请求体

请求示例（参数未编码，调用时请编码）：

datasourceId=1&product=data_transform&user=grp.mammut@163.com&pageNum=1&pageSize=10

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": {

        "pageNum": 1,

        "pageSize": 10,

        "totalCount": 23,

        "totalPage": 3,

        "list":\[

            {

                "db": "default"

            },

            {

                ......

            }

            ......

        \]

    }

    "reqId": "b88d054742c04baea4cad4169be01daa",

    "cost": 21

}

2.3.2 数据源表名列表获取

GET /table/v1/name/list

产品版本：v4.9.0

描述：获取某数据源某db下table名列表

URL参数/请求体

请求示例（参数未编码，调用时请编码）：

datasourceId=1&product=mammut&user=grp.mammut@163.com&db=default&pageNum=1&pageSize=10

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": {

        "pageNum": 1,

        "pageSize": 10,

        "totalCount": 23,

        "totalPage": 3,

        "list":\[

            "table1","table2",......

        \]

    }

    "reqId": "b88d054742c04baea4cad4169be01daa",

    "cost": 21

}

2.3.3 数据源表详情列表获取

GET /table/v1/list

产品版本：v4.9.0

描述：获取某数据源某db下table名列表

URL参数/请求体

请求示例（参数未编码，调用时请编码）：

datasourceId=11&product=mammut&user=grp.mammut@163.com&db=default&pageNum=1&pageSize=10

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": {

        "pageNum": 1,

        "pageSize": 10,

        "totalCount": 23,

        "totalPage": 3,

        "list":\[

            {

                "table": "test\_table"，

                "creator": "zhangsan"，

                "createdTime": "2022-06-13 02:00:00"，

                "comment": "测试表"，

                "tableType": "MANAGED\_TABLE",

                "fields":\[

                    {

                        "fieldName": "id",

                        "fieldType": "int",

                        "partitionKey": false,

                        "comment": "id名"

                    },

                    {

                        ......

                    }

                    ......

                \]

            },

            {

                ......

            }

            ......

        \]

    }

    "reqId": "b88d054742c04baea4cad4169be01daa",

    "cost": 21

}

2.3.4 数据源表详情获取

GET /table/v1/get

产品版本：v4.9.0

描述：获取某数据源某db某张表详情

URL参数/请求体

请求示例（参数未编码，调用时请编码）：

datasourceId=11&product=mammut&user=grp.mammut@163.com&db=default&table=test

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": {

                "table": "test\_table"，

                "creator": "zhangsan"，

                "createdTime": "2022-06-13 02:00:00"，

                "comment": "测试表"，

                "tableType": "MANAGED\_TABLE",

                "fields":\[

                    {

                        "fieldName": "id",

                        "fieldType": "int",

                        "partitionKey": false,

                        "comment": "id名"

                    },

                    {

                        ......

                    }

                    ......

                \]

            },

    "reqId": "b88d054742c04baea4cad4169be01daa",

    "cost": 21

}

2.4 血缘获取API

2.4.1 表血缘获取详情

GET /lineage/v1/table/get

产品版本：v5.7.0

描述：获取某张表上下游的表血缘

URL参数/请求体

请求示例（参数未编码，调用时请编码）：

datasourceId=11&product=mammut&user=grp.mammut@163.com&db=default&table=test&direction=up&pageSize=10&pageNum=0

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": {

                "datasourceId": 111,

                "catalog": "catalog\_011",

                "db": "default",

                "table": "test",

                "tableId": "catalog\_011.default.test",

                "datasourceType": "hive",

                "updateTime": 1678074656000,

                "direction": "up",

                "parentList":\[

                     "pageNum": 1,

                     "pageSize": 10,

                     "totalCount": 23,

                     "totalPage": 3,

                    {

                        "datasourceId":111,

                        "catalog": "catalog\_011",

                        "db": "default",

                        "table": "test11",

                        "tableId": "catalog\_011.default.test11",

                        "datasourceType": "hive",

                        "updateTime": 1678074656000,

                        "platform":"mammut",

                        "taskId":"12223"

                    },

                    {

                        ......

                    }

                    ......

                \],

                "referList":\[

                    {

                        "nodeId":"111",

                        "nodeName": "apiTest",

                        "source": "api",

                        "nodeUpdateTime": 1678074656000,

                        "relUpdateTime": 1678074656000

                    },

                    {

                        ......

                    }

                    ......

                \]

            },

    "reqId": "b88d054742c04baea4cad4169be01daa",

    "cost": 21

}

2.4.2 字段血缘获取详情

GET /lineage/v1/field/get

产品版本：v5.7.0

描述：获取某个字段上下游的血缘

URL参数/请求体

请求示例（参数未编码，调用时请编码）：

datasourceId=11&product=mammut&user=grp.mammut@163.com&db=default&table=test&fieldName=a&direction=up&pageSize=10&pageNum=0

响应体

响应示例：

{

    "code": 0,

    "msg": null,

    "result": {

                "datasourceId":111,

                "catalog": "catalog\_011",

                "db": "default",

                "table": "test",

                "filedName":"a",

                "fieldId": "catalog\_011.default.test.a",

                "datasourceType": "hive",

                "direction":"up",

                "updateTime": 1678074656000,

                "parentList":\[

                     "pageNum": 1,

                     "pageSize": 10,

                     "totalCount": 23,

                     "totalPage": 3,

                        {

                            "datasourceId":111,

                            "catalog": "catalog\_011"，

                            "db": "default"，

                            "table": "test11"，

                            "fieldName": "a",

                            "fieldId": "catalog\_011.default.test11.a"，

                            "fieldRelation":"PROJECTION",

                            "datasourceType": "hive",

                            "updateTime": 1678074656000,

                            "platform":"mammut",

                            "taskId":"12223"

                        },

                        {

                            ......

                        }

                        ......

                    \]

                \],

                 "referList":\[

                    {

                        "nodeId":"111",

                        "nodeName": "apiTest",

                        "source": "api",

                        "nodeUpdateTime": 1678074656000,

                        "relUpdateTime": 1678074656000

                    },

                    {

                        ......

                    }

                    ......

                \]

            },

    "reqId": "b88d054742c04baea4cad4169be01daa",

    "cost": 21

}