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

OpenAPI 使用方法和通用说明请参考：

OpenAPI通用规范说明，实时计算平台对应的子产品代号为：easystream

一 公共参数

1.1 响应格式

1.2 响应码(1000~9999)

1.3 公共枚举定义

1.3.1 EngineTypeEnum

1.3.2 StartMode

1.3.3 JobStatusEnum 任务运行状态

1.3.4 SearchTypeEnum 检索类型

1.3.5 JobTypeEnum 任务类型

1.3.6 DatasourceTypeEnum 数据源类型

同元数据中心大小写保持一致.

1.3.7 TABLE_TYPE 流表的类型

1.3.8 CheckpointStatusEnum checkpoint 状态

1.4 查询实体列表

1.4.1 JobTaskConfig

任务参数配置

字段说明：

1.4.2 JobResourceConfig

1.4.3 CheckpointMode

1.4.4 StateBackend 存储介质

1.4.5 RestartStrategy 重启策略

如果没有启用 checkpointing，则使用无重启 (no restart) 策略。

如果启用了 checkpointing，但没有配置重启策略，则使用固定间隔 (fixed-delay) 策略

fixed-delay** 需要传入重启失败次数和重试时间间隔**

failure-rate 需要传入 重启失败次数、重启时间范围、重试时间间隔

1.4.6 StartJobInfo

任务启动参数配置

字段说明：

1.4.7 StopJobInfo

任务停止参数配置

1.4.8 RestartJobInfo

任务重启参数配置

1.4.9 AlarmInfo

告警信息配置

1.4.10 AlarmRule

告警规则

1.4.11 ParamSetInfo

1.5 响应实体列表

1.5.1 JobBasicInfo

1.5.2 ResourceFileSimpleInfo

1.5.3 UdfSimpleInfo

注意: 手动选择函数依赖的方式, udfList参数中不会显示udf信息,请尽快下线,

推荐采用对接udf stuido的新方式使用.

1.5.4 StartJobResult

1.5.5 StopJobResult

1.5.6 RestartJobResult

1.5.7 JobStatus

1.5.8 ProductInfo

1.5.9 ClusterInfo

1.5.10 UserInfo

1.5.11 LineageSearchTips

1.5.12 LineageSearch

1.5.13 TableDetail

1.5.14 MetaProp

1.5.15 FieldNode

1.5.16 TableSimpleDetail 流表简要信息

1.5.17 ProductClusterVo项目-集群信息

1.5.18 OpsJobBasicInfo运维任务基本信息

1.5.19 JobCurrentCheckpointInfo 当前运行的checkpoint

1.5.20 JobCheckpointInfo 任务的历史checkpoint

1.5.21 JobSavepointtInfo 任务的历史savepoint

1.6 备注

1.6.1 字段支持的数据源类型

不同数据源支持的参数类型不同，具体阅读用户手册

1.6.2 DATASOURCE_TYPE 流表支持的数据源类型

二、OpenAPI列表

2.1 任务OpenAPI

2.1.1 新建SQL 任务

POST /job/v2/sql/create

版本：3.9.10

描述：创建SQL类型的任务

URL参数/请求体

请求示例：

{

"product": "sloth",

"clusterId": "dev4",

"user": "abc@example.com",

"jobName": "jarName",

"engineType": "FLINK1\_12\_0",

"folderPath": "/tmp/dir",

"rawSql": "this is sql",

"description": "sql job description",

"dependencyIds": \[

    1,

    2,

    4

\],

"paramSetList" : \[

    {

        "id" : 1,

        "priority" : 1           

    },

    {

        "id" : 2,

        "priority" : 2           

    }

\],

"jobTaskConfig" : {

    "checkpointSwitch" : true,

    "checkpointMode" : "EXACTLY\_ONCE"

},

"jobResourceConfig" : {

    "resourceInstanceName" : "sloth\_yarn\_cluster\_name",

    "queueName" : "sloth\_queue\_name"

}

}

返回示例：

{

"code": 0,

"msg": "success",

"result": {

    "jobId":"104722"

},

"requestId": null,

"reqId": null,

"cost": 2072

}

2.1.2 修改SQL任务

POST /job/v2/sql/modify

版本：3.9.10

描述：修改SQL类型的任务

URL参数/请求体

请求示例：

{

"jobId": "104722",

"product": "sloth",

"clusterId": "dev4",

"user": "abc@example.com",

"jobName": "jarName",

"engineType": "FLINK1\_12\_0",

"folderPath": "/tmp/dir",

"rawSql": "this is sql",

"description": "sql job description",

"dependencyIds": \[

    1,

    2,

    4

\],

"paramSetInfo" : \[

    {

        "id" : 1,

        "priority" : 1           

    },

    {

        "id" : 2,

        "priority" : 2           

    }

\],

"jobTaskConfig" : {

    "checkpointSwitch" : true,

    "checkpointMode" : "EXACTLY\_ONCE"

},

"jobResourceConfig" : {

    "resourceInstanceName" : "sloth\_yarn\_cluster\_name",

    "queueName" : "sloth\_queue\_name"

}

}

返回示例：

{

"code": 0,

"msg": "success",

"result": null,

"requestId": null,

"reqId": null,

"cost": 2072

}

2.1.3 获取任务信息

POST /job/v2/detail

版本：3.9.10

描述：获取最新版本任务信息

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4",

"jobId": 1000056

}

响应体描述：

响应体示例：

{

"code": 0,

"msg": "success",

"result": {

    "jobBasicInfo": {

        "jobId": 1000056,

        "jobName": "测试任务2-rename",

        "jobType": "SQL",

        "rawSql": "\[{\\"cellType\\":\\"flink.sql\\",\\"enable\\":true,\\"key\\":\\"743a695f-9099-11ec-ad7c-fa163ea49987\\",\\"source\\":\[\\"--SQL\\",\\"--\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*--\\",\\"--Author: 杨晓航\\",\\"--CreateTime: 2021-12-09 15:57:41\\",\\"--Comment: 请输入业务注释信息\\",\\"--\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*--\\",\\"CREATE TABLE user\_log (\\",\\"user\_id VARCHAR,\\",\\"item\_id VARCHAR,\\",\\"category\_id VARCHAR,\\",\\"behavior VARCHAR,\\",\\"ts VARCHAR\\",\\") WITH (\\",\\"'connector' = 'datagen'\\",\\"-- , 'number-of-rows' = '10'\\",\\");\\",\\"\\",\\"create table print\_table WITH ('connector' = 'print')\\",\\"LIKE user\_log (EXCLUDING ALL);\\",\\"\\",\\"insert into print\_table\\",\\"select \* from user\_log;\\"\],\\"title\\":\\"SQL\\"}\]",

        "udfList": \[

            {

                "uid" : "xxxxxxxxxx"

                "name": "udf\_function",

                "className": "com.xxx.xx",

                "resourceUid": "xxxxxxxxx",

                "md5":"xxxxxx"

            }

        \],

        "paramSetList": \[

            {

            "id" : 1,

            "name" : "sloth\_param\_set\_1"

            "priority" : 1,                          

            },

            {

            "id" : 2,

            "name" : "sloth\_param\_set\_2"

            "priority" : 2,                          

            }

        \]

        "fileList": \[\],

        "creator": "abc@example.com",

        "createTime": "2021-12-09T07:57:41.000+0000",

        "publisher": "abc@example.com",

        "env": 381,

        "category": 351,

        "tags": \[\],

        "description": "xxxxxx",

        "lastStartJobExecHistoryId": 2745,

        "startExecId": 2036,

        "lastResourceInstanceId": 1,

        "jobStatus": "FAILED",

        "applicationId": "",

        "flinkUrl": "http://sloth-test2.dg.163.org:8088/proxy/application\_1645065290019\_0491/#/overview",

        "monitorUrl": "http://sloth.bdms.netease.com/grafana/d/rZuGINgWk/sloth?orgId=1&var-jobAppKey=1000056&var-jobSource=sloth&from=1648028948000&to=1648696837704"

    }

},

"requestId": dcaf583d,

"cost": 12

}

2.1.4 删除任务

POST /job/v2/delete

版本：3.9.10

描述：删除调用方传入的任务列表

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4",

"jobIds": "1000074,1000071"

}

响应体：

返回操作记录的id

{

"code": 0,

"msg": "success",

"result": 1354,

"requestId": dcaf583d,

"cost": 12

}

2.1.5 启动任务

POST /job/v2/start

版本：3.9.10

描述：启动调用方传入的任务

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4",

"jobInfos": \[

    {

        "jobId": 1000074,

        "startMode": "NONE",

        "statePath": "hdfs://dev4/user/sloth/sloth-fs-savepoints/spt/ckp-111"

    }

\]

}

响应体描述：

响应体示例：

{

"code": 0,

"msg": "success",

"result": {

    "results": \[

        {

            "jobId": 1000074,

            "jobName": "testOpenApi",

            "isSuccess": true,

            "errorMessage": ""

        }

    \]

},

"requestId": "914abf5efc64444d92f92418e3c9840c",

"cost": 12

}

2.1.6 停止任务

POST /job/v2/stop

版本：3.9.10

描述：停止调用方传入的任务

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4",

"jobInfos": \[

    {

        "jobId": 1000096,

        "triggerSavepoint": false

    }

\]

}

响应体描述：

响应体实例：

{

"code": 0,

"msg": "success",

"result": {

    "results": \[

        {

            "jobId": 1000096,

            "jobName": "sqlOpenApiTest3",

            "isSuccess": true,

            "errorMessage": ""

        }

    \]

},

"requestId": "9483bdc3f6d84be7a74f26cb78bd4b6a",

"cost": 12

}

2.1.7 重启任务

POST /job/v2/restart

版本：3.9.10

描述：重新启动调用方传入的任务

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4",

"jobInfos": \[

    {

        "jobId": 1000096,

        "startMode": "NONE",

        "statePath": "",

        "triggerSavepoint": false

    }

\]

}

响应体描述：

响应体实例：

{

"code": 0,

"msg": "success",

"result": {

    "results": \[

        {

            "jobId": 1000096,

            "isSuccess": true,

            "errorMessage": ""

        }

    \]

},

"requestId": "19cd594800684549aa420e100f241fc5",

"cost": 12

}

2.1.8 获取任务当前状态

POST /job/v2/status

版本：3.9.10

描述：批量获取调用方传入任务的当前状态信息

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4",

"jobIds": "100056"

}

响应体描述：

响应体实例：

{

"code": 0,

"msg": "success",

"result": {

    "jobStatusList": \[

        {

            "jobId": "1000056",

            "jobStatus": "FAILED"

        }

    \]

},

"requestId": dcaf583d,

"cost": 12

}

2.1.9 新建JAR任务

POST /job/v2/jar/create

版本：3.9.10

描述：创建SQL类型的任务

URL参数/请求体

请求示例：

{

"product": "sloth",

"clusterId": "dev4",

"user": "abc@example.com",

"jobName": "jarName",

"engineType": "FLINK1\_12\_0",

"folderPath": "/tmp/dir",

"description": "sql job description",

"dependencyIds": \[

1,

2,

4

\],

"jobTaskConfig": {

"checkpointSwitch": true,

"checkpointMode": "EXACTLY\_ONCE"

},

"jobResourceConfig": {

"resourceInstanceName": "sloth\_yarn\_cluster\_name",

"queueName": "sloth\_queue\_name"

},

"jarHdfs": "hdfs://test/test",

"jarName": "test.jar",

"mainClass": "com.net.MainClass",

"mainArgs": "-- args"

}

返回示例：

{

"code": 0,

"msg": "success",

"result": {

    "jobId":"104722"

},

"requestId": null,

"reqId": null,

"cost": 2072

}

2.1.10 修改JAR任务

POST /job/v2/jar/modify

版本：3.9.15

描述：修改JAR类型的任务

URL参数/请求体

请求示例：

{

    "jobId": "104722",

    "product": "sloth",

    "clusterId": "dev4",

    "user": "abc@example.com",

    "jobName": "jarName",

    "engineType": "FLINK1\_12\_0",

    "folderPath": "/tmp/dir",

    "description": "sql job description",

    "dependencyIds": \[

        1,

        2,

        4

    \],

    "jobTaskConfig" : {

        "checkpointSwitch" : true,

        "checkpointMode" : "EXACTLY\_ONCE"

    },

    "jobResourceConfig" : {

        "resourceInstanceName" : "sloth\_yarn\_cluster\_name",

        "queueName" : "sloth\_queue\_name"

    },

"jarHdfs": "hdfs://test/test",

"jarName": "test.jar",

"mainClass": "com.net.MainClass",

"mainArgs": "-- args"

}

返回示例：

{

    "code": 0,

    "msg": "success",

    "result": null,

    "requestId": null,

    "reqId": null,

    "cost": 2072

}

2.1.11 建立文件上传链接

POST /dev/v1/file/shard-upload/connect

版本：3.9.15

描述：建立文件上传前的初始化工作，包括分块等功能

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4",

"fileMd5": "903054ff6d80c555aa47f8d3bd83c77c",

"fileName": "Easystream-20230421-135940-0272.zip",

"totalChunkNum": 1

}

响应体描述：

响应体实例：

{

"code": 0,

"msg": "success",

"result": {

"fileMd5": "903054ff6d80c555aa47f8d3bd83c77c",

"fileName": "Easystream-20230421-135940-0272.zip",

"uuid": "e7689c9b80204b9e9d7c95fbe357cd03",

"nextChunkNum": 0,

"msg": null,

"status": 0

},

"requestId": null,

"reqId": null,

"cost": 0

}

2.1.12 文件分片上传

POST /dev/v1/file/shard-upload/do

版本：3.9.15

描述：将分片之后的文件分块上传到服务器

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4",

"fileMd5": "903054ff6d80c555aa47f8d3bd83c77c",

    "uuid": "e7689c9b80204b9e9d7c95fbe357cd03",

"fileName": "Easystream-20230421-135940-0272.zip",

"curChunkNum": 0

}

二进制分块文件 file :(binary)

响应体描述：

响应体实例：

{

"code": 0,

"msg": "success",

"result": {

"fileMd5": "903054ff6d80c555aa47f8d3bd83c77c",

"fileName": "Easystream-20230421-135940-0272.zip",

"uuid": "e7689c9b80204b9e9d7c95fbe357cd03",

"nextChunkNum": 0,

"msg": null,

"status": 0

},

"requestId": null,

"reqId": null,

"cost": 0

}

2.1.13 获取文件上传状态

POST /dev/v1/file/shard-upload/status/get

版本：3.9.15

描述：将分片之后的文件分块上传到服务器

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4",

"fileMd5": "903054ff6d80c555aa47f8d3bd83c77c",

    "uuid": "e7689c9b80204b9e9d7c95fbe357cd03",

"fileName": "Easystream-20230421-135940-0272.zip"

}

响应体描述：

响应体实例：

{

"code": 0,

"msg": "success",

"result": {

"fileMd5": "903054ff6d80c555aa47f8d3bd83c77c",

"fileName": "Easystream-20230421-135940-0272.zip",

"uuid": "e7689c9b80204b9e9d7c95fbe357cd03",

"nextChunkNum": 0,

"msg": null,

"status": 0,

        "hdfsPath": "hdsf://usr/sloth/xxx",

},

"requestId": null,

"reqId": null,

"cost": 0

}

2.1.14 获取运维任务列表

GET /ops/v1/job/list

版本：3.9.17

描述：获取运维任务的列表

URL参数/请求体：

请求示例：

{

    "user": "abc@example.com",

    "product": "sloth",

    "clusterId": "dev4",

    "pageNum": 1,

    "pageSize": 25,

    "jobType": "SQL",

    "jobStatus": "RUNNING",

    "owner": "test@163.com"

}

响应体描述：

响应体示例：

{

"code": 0,

"cost": 0,

"msg": "success",

"reqId": "",

"requestId": "733a841b54154592a578084706f6d39b",

"result": {

"data": \[

{

"jobId": 1111111133,

"jobName": "贵州Test-03",

"jobType": "JAR",

"jobStatus": "RUNNING",

"env": "test",

"category": "P0",

"owner": \[

{

"user": "abc@example.com",

"fullName": "xxx"

}

\],

"lastStartTime": "2023-08-22 11:16:30",

"vCore": 2.0,

"memory": 2.5,

"jobUrl": "http:xxxx"

}

\],

"jobTypeSummary": {

"JAR": 5,

"SQL": 3,

"CDC": 1

},

"count": 5

},

"success": true

}

2.1.15 获取任务当前运行的checkpoint

GET ops/v1/job/checkpoint/current-list

版本：3.9.17

描述：获取当前任务checkpoint列表

URL参数/请求体：

请求示例：

{

    "user": "abc@example.com",

"product": "xxxx",

"clusterId": "dev4",

    "jobId": "123123"

}

响应体描述：

响应体实例：

{

    "code": 0,

    "msg": "success",

    "result": {

        "count": 1,

        "data": \[

            {

                "checkpointDisplayDuration": "125 ms",

                "checkpointDisplaySize": "22.8 KB",

                "checkpointDuration": 125,

                "checkpointName": "45e54d8a8018101d38909ae0964f5ccb/chk-1",

                "checkpointPath": "hdfs://xxxxxx/user/xxxx/sloth-fs-checkpoints/meta/1\_7/45e54d8a8018101d38909ae0964f5ccb/chk-1",

                "checkpointSize": 23351,

                "checkpointStatus": "COMPLETED",

                "checkpointTime": "2023-08-28 14:20:22",

                "jobExecId": "2748",

                "jobId": "103755"

            }

        \]

    },

    "requestId": null,

    "reqId": null,

    "cost": 203

}

2.1.16 获取任务历史checkpoint

GET ops/v1/job/checkpoint/list

版本：3.9.17

描述：获取任务历史checkpoint

URL参数/请求体：

请求示例：

{

    "user": "abc@example.com",

"product": "xxxx",

"clusterId": "dev4",

    "jobId": "123123",

    "pageNum": 1,

    "pageSize": 25,

}

响应体描述：

响应体实例：

{

    "code": 0,

    "msg": "success",

    "result": {

        "count": 1,

        "data": \[

            {

                "checkpointDisplaySize":"31.73 KB",

                "checkpointName":"57193cfcdc4d08a534d67a02bdd2bd2c/chk-10",

                "checkpointPath":"hdfs://xxx/user/xxxx/sloth-fs-checkpoints/meta/1\_7/57193cfcdc4d08a534d67a02bdd2bd2c/chk-10",

                "checkpointSize":32487,

                "checkpointTime":"2023-08-24 20:30:39",

                "jobExecId":2730,

                "jobId":"103755"

                }

        \]

    },

    "requestId": null,

    "reqId": null,

    "cost": 203

}

2.1.17 获取任务历史savepoint

GET ops/v1/job/savepoint/list

版本：3.9.17

描述：获取任务历史savepoint

URL参数/请求体：

请求示例：

{

    "user": "abc@example.com",

"product": "xxxx",

"clusterId": "dev4",

    "jobId": "123123",

    "pageNum": 1,

    "pageSize": 25,

}

响应体描述：

响应体实例：

{

    "code": 0,

    "msg": "success",

    "result": {

        "count": 1,

        "data": \[

            {

                "jobExecId": "2730",

                "jobId": "103755",

                "savepointDisplaySize": "10 KB",

                "savepointName": "57193cfcdc4d08a534d67a02bdd2bd2c/savepoint-57193c-1344de949652",

                "savepointPath": "hdfs://xxxx/user/sloth/sloth-fs-savepoints/spt/57193cfcdc4d08a534d67a02bdd2bd2c/savepoint-57193c-1344de949652",

                "savepointSize": 11113,

                "savepointTime": "2023-08-24 20:30:44"

            }

        \]

    },

    "requestId": null,

    "reqId": null,

    "cost": 203

}

2.2 平台OpenAPI

2.2.1 获取用户

GET /platform/v2/getUserList

版本：3.9.16

描述：获取用户集合

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "dev4"

}

响应体描述：

响应体实例：

{

}

{

"code": 0,

"msg": "success",

"result": \[

{

"user":"abc@example.com",

        "fullName":"张三"

}

\],

"requestId": "3d8a45dc",

    "cost": 12

}

2.2.2 获取当前项目组下面已经初始化过的项目-集群列表

GET /dev/v3/platform/productGroup/productAndClusterList

版本：3.9.15

描述：获取当前项目组下面已经初始化过的项目-集群列表

URL参数/请求体：

请求示例：

user: abc@example.com

product: sloth

clusterId: hz10

响应体描述：

响应体实例：

{

"code": 0,

"msg": "success",

"result": \[

{

"product": "linna\_prd\_d",

"clusterIdList": \[

{

"clusterId": "dev4",

"clusterName": "开发集群"

}

\]

}

\],

"requestId": "3d8a45dc",

    "cost": 12

}

2.3 血缘OpenAPI

2.3.1 血缘检索提示

POST /lineage/v2/search/tips

版本：3.9.16

描述：根据搜索类型模糊匹配获取血缘提示信息

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "xxxx",

"clusterId": "dev4"

    "keyword":"sloth",

    "searchType":"DATASOURCE\_NAME"

}

响应体描述：

响应体实例：

{

    "code": 0,

    "msg": "success",

    "result": \[

        {

            "product": "",

            "catalog": "sloth\_api\_autotest\_catalog\_17",

            "datasourceName": "",

            "db": "",

            "table": "",

            "datasourceType": "kafka",

            "searchType": "CATALOG",

            "connectorUrl": "",

            "clusterId": ""

        }

    \],

    "requestId": null,

    "reqId": null,

    "cost": 169

}

2.3.2 血缘检索结果

POST /lineage/v2/search

版本：3.9.16

描述：根据搜索类型完全匹配获取血缘信息

URL参数/请求体：

请求示例：

{

    "user": "abc@example.com",

"product": "xxxx",

"clusterId": "dev4"

    "searchType":"DATASOURCE\_NAME"

    "catalog": "sloth\_api\_autotest\_catalog\_17",

    "connectorUrl": "",

    "datasourceType": \["kafka"\],

    "db": "test",

    "table": "sloth\_lineage\_kafka\_114",

    "pageNum": 1,

    "pageSize": 25,

    "owner": \[\],

    "jobStatus": \[\],

    "searchProduct": "",

    "searchMammutCluster": ""

}

响应体描述：

响应体实例：

{

    "code": 0,

    "msg": "success",

    "result": {

        "count": 1,

        "data": \[

            {

                "product": "xxxx",

                "jobId": "1548",

                "jobName": "job\_xxxx",

                "url": "http://xxxxxxxx",

                "jobType": "SQL",

                "jobStatus": "FAILED",

                "version": "v3",

                "owner": \[

                    {

                        "user": "abc@example.com",

                        "fullName": "xxxxxx"

                    }

                \],

                "referenceInfo": "非流表",

                "clusterId": "easyops-cluster",

                "clusterName": "easyops-cluster"

            }

        \]

    },

    "requestId": null,

    "reqId": null,

    "cost": 203

}

2.4 流表管理

流表管理主要涉及如下阶段：

根据数据源类型找到数据源列表。

根据数据源找到对应的物理表和物理库。

获取到支持的序列化方式（只有消息队列有）。

填入字段，kafka可以通过消息自动生成字段，关系型数据库可以根据访问数据源直接获取字段。

获取支持的配置列表，并填入需要的配置。

保存、删除、查看、列表查看。

2.4.1 获取流表库列表

GET /dev/v1/meta/databases/list

版本：3.9.15

描述：获取本项目下面流表库的列表

URL参数/请求体：

请求示例：

db: a123

user: abc@example.com

product: mammut\_service

clusterId: easyops-cluster

publicDatabase: false

响应体描述：注意列表获取列表时字段信息不会返回

响应体实例：

{

"code": 0,

"msg": "success",

"result": \[

{

"catalog": "intern\_default\_catalog",

"db": "AA",

"id": 157

}

\],

"requestId": "b9fc7431"

}

2.4.2 登记流表库

POST /dev/v1/meta/databases/add

版本：3.9.15

描述：登记流表库(包含公共流表)

URL参数/请求体：

请求示例：

{

"user": "abc@example.com",

"product": "sloth",

"clusterId": "hz10",

"db": "test",

"publicDatabase": true

}

响应体实例：

{

"code": 0,

"msg": "success",

"result": null,

"requestId": "b9fc7431",

    "cost": 12

}

2.4.3 获取流表列表

GET /dev/v1/meta/tables/list

版本：3.9.15

描述：建立文件上传前的初始化工作，包括分块等功能

URL参数/请求体：

请求示例：

catalog: public\_xx\_default\_catalog

db: a123

table: dev

datasourceType: kafka

usedTableTagList: SINK\_TABLE

pageNum: 1

pageSize: 25

user: abc@example.com

product: mammut\_service

clusterId: easyops-cluster

fromCluster: dev4

fromProduct: sloth

响应体描述：注意列表获取列表时字段信息不会返回

响应体实例：

{

"code": 0,

"msg": "success",

"result": {

"data": \[

{

"id": 2093,

"db": "lyb\_db",

"datasourceType": "kafka",

                "catalog": "poc\_db",

"table": "t1",

                "datasourceCatalog": "绑定数据源的catlaog",

"modifier":{"user":"abc@example.com","fullName":"lyb"}

"updateTime": "2023-05-19 15:26:47",

"availableTableTags": \[\],

                "publicTable": true,

                "fromProductCluster": "sloth-开发集群",

                "publicRange": 1,

                "publicProductAndCluster":\[

                    {

                        "product":"sloth",

                        "clusterId":"dev4",

                        "clusterName":"开发集群"                   

                    }               

                \]

}

\],

"count": 4

},

"requestId": "de61c920",

    "cost": 12

}