SQLink 集成与接口参考

本页面向需要把血缘能力接入其他应用的开发者。接口路径与参数依据产品手册整理，调用前应与目标服务实际接口定义核对。示例不包含真实地址、凭据或对象 ID。

DAM 内集成

DAM 的血缘空间、预处理和命名空间管理可使用 SQLink 的相应管理能力；从元数据对象进入的血缘与独立“数据血缘”栏目分属不同授权范围。后者包含数据目录、血缘地图、应用场景及在线血缘，参见许可边界。

元数据对象的血缘页面可通过嵌入方式呈现，但嵌入本身不会授予额外权限。

请求约定

基础路径为部署服务下的 /sqlink，下表路径追加在此之后。所列接口使用 POST。默认请求、响应为 JSON；文件上传使用 multipart/form-data，模板下载返回二进制内容。

认证继承系统统一认证。实际认证头、Token 获取和有效期应按当前部署配置，不在此虚构固定认证头。失败时区分参数错误、认证失败、路径或对象不存在、服务异常；HTTP 成功还需核对业务结果。

命名空间、标签与自定义关系

操作	路径	主要请求内容
创建命名空间	/dataArea/createDataArea	Body：必填 name、objectType；可选 defaultSchemas
查看元数据覆盖率	/dataArea/getMetadataCoverage	Query：必填 namespaceId（Long）
批量删除命名空间	/dataArea/deleteDataArea	Body：命名空间 ID 数组；有相关血缘文件时不能直接删除
创建自定义血缘	/customLineage/create	Body：name、edges 必填，description 可选；每条边包含 startId、endId
为对象添加标签	/tag/addTag	Body：objectId、tagIds；可配置扩散
查标签关联对象	/tag/getByTag	Query：必填 tagId（Long）

标签扩散参数包括 diffusion、direction、depth。方向取 FORWARD（下游）、BACKWARD（上游）或 ALL；扩散默认关闭，启用后应明确深度与实际影响范围。

查询图谱、加工逻辑和影响

操作	路径	请求与结果
查询图谱	/lineageGraph/query	Body 指定节点和查询条件，返回子图
获取加工逻辑	/lineageGraph/getTransform	Body 使用图查询条件并指定 id 或 queryIds；Query 可用 isGraph 控制图内模式
获取影响结果	/lineageGraph/getImpact	Body 指定节点、方向、深度及资源类型

参数类型、必填项、默认值、响应字段以及各接口的方向枚举差异，见查询接口详解。解释结果前核对方向、粒度及是否排除了临时对象；不能把图查询的全部参数直接套用到影响分析。

文件、SQL 与断链任务

操作	路径	请求内容
上传文件	/lineage/uploadLineageFile	Query：lineageEngine、objectType、folderId 必填，defaultSchema、parse 可选；Body：二进制 file
解析 SQL	/lineage/parse	Body：必填 sqlContent，可选 defaultSchema、sqlType
发起断链分析	/lineage/executeBrokenLineageJob	Body 可限定 sourceNamespaces、targetNamespaces、direction

SQL 请求结构示例：

{
  "sqlContent": "INSERT INTO demo_target.orders SELECT order_id FROM demo_source.orders",
  "defaultSchema": "demo_target",
  "sqlType": "DML"
}

demo_source 和 demo_target 是示例 Schema，需替换为获准使用的对象上下文。解析请求与实际执行数据库 SQL 是不同操作。上传返回文件 ID后还需检查是否解析、解析报告及对象匹配。

预处理脚本与调度

操作	路径	请求内容
创建脚本	/script/createScript	Body：name、scriptType、objectType、scriptContent；可选 enabled
下载脚本模板	/script/exportScriptTemplates	返回可用于导入的 Excel 模板
创建任务	/job/createJob	Body：名称、绑定资源、调度与执行类等任务配置
立即运行	/job/runJob	Query：jobId；可选 Body 任务描述符覆盖默认参数

scriptType 使用 JAVASCRIPT、REGEX 或 LLM。创建任务需要 name、bindResourceId、bindResourceType、schedule、className，可带 description 和 jobContent。绑定类型和执行类应从适配任务定义取得，不自行猜测 Java 类名。

立即运行返回任务实例标识，不等于任务完成，应通过任务执行记录检查结果。删除命名空间、标签扩散、上传自动解析和任务执行均会改变服务数据，集成测试应明确范围并避免重复提交已成功的操作。