查询血缘图谱、加工逻辑与影响范围
本页整理原接口手册中有参数表和响应示例的查询接口,供第三方集成时核对。认证和服务入口遵循集成约定。接口方法均为 POST,下列路径追加在服务的 /sqlink 基础路径后。
文中对象 ID、标签和示例值需要替换为目标环境的实际标识。不要把显示名称、物理表名或另一个环境的 ID 直接当作同一对象。
“血缘子图”是以指定对象为起点,按方向、深度和过滤条件截取的一部分血缘节点与关系,不是整个 SQLink 血缘库;“加工逻辑”是连接输入与输出的转换语句或处理描述;“影响范围”是依据当前已采集、已解析关系得到的潜在关联对象,不等于已确认的实际业务损失。使用接口结果前应核对这三个口径。
查询血缘子图
需要跨模块组合元数据、资产和血缘时,可先查看 DAM REST API 场景指南。该指南按服务职责筛选接口,并说明与旧接口手册的枚举差异;实际调用采用目标部署的契约。
路径:/lineageGraph/query。参数放在 JSON Body 中。
| 参数 | 类型 | 必填 | 含义及原接口说明的默认值 |
|---|---|---|---|
id | String | 是 | 目标节点 ID |
queryType | String | 否 | SCHEMA、TABLE、COLUMN;默认 TABLE |
depth | Integer | 否 | 查询深度;默认 3 |
direction | String | 否 | FORWARD 下游、BACKWARD 上游、ALL 全链路;默认 ALL |
hasTemp | Boolean | 否 | 是否显示临时表;默认 false |
tags | Array | 否 | 标签过滤;原示例使用标签名称列表,与添加标签接口的 tagIds 不同 |
调用时建议显式填写影响范围的参数,避免默认值与使用目标不一致。以下为请求结构示例,example-node-id 不是可直接调用的真实标识:
{
"id": "example-node-id",
"queryType": "TABLE",
"depth": 2,
"direction": "FORWARD",
"hasTemp": false
}响应示例包含 nodes 和 relationships。节点记录中有 id、name、parentId、type 和 properties;关系通过 srcId、dstId 关联节点,并提供 lineageId 及关系属性。
检查返回结果时,先核对起始对象、方向、深度和过滤条件,再检查节点与关系能否对应。某对象未出现,可能受本次深度或过滤影响,不能直接判定全平台没有此对象的血缘。
获取加工逻辑
路径:/lineageGraph/getTransform。
- Query 中的
isGraph为可选 Boolean,原说明默认true,用于图内模式。 - Body 使用图查询条件,并指定目标
id。原说明也提到queryIds,但未完整给出它的参数结构;批量调用前应以目标接口定义为准。 - 返回加工逻辑列表,示例字段包括
startIds、endId、transforms、lineageName、lineageId和lineageTransformationType。
transforms 中的转换语句用于解释加工关系。将其与源脚本、输入对象和输出对象相互核对,不把聚焦片段直接当作可独立运行的完整作业。界面操作见代码裁剪。
查询影响范围
路径:/lineageGraph/getImpact。参数放在 JSON Body 中。
| 参数 | 类型 | 必填 | 含义及原接口说明的默认值 |
|---|---|---|---|
id | String | 是 | 分析基准节点 ID |
direction | String | 否 | FORWARD 或 BACKWARD,默认 FORWARD;不要直接套用图查询的所有方向枚举 |
depth | Integer | 否 | 影响分析深度,默认 3 |
resourceTypes | Array | 否 | 可过滤 TABLE、REPORT、COLUMN;需要限制时显式传入数组 |
响应为影响对象列表,示例字段有 id、name、alias、type、dataArea 和 direction。原参数表对不限类型的描述与数组类型未完全对应,因此不要自行把字符串 ALL 填入数组参数;按目标接口定义处理不限范围的调用。
影响列表提供变更影响线索,不自动通知责任人或修改下游资产。结合应用场景检查业务影响。
查询命名空间统计
路径:/dataArea/getMetadataCoverage。Query 参数 namespaceId 必填,类型为 Long。
响应中的统计字段包括:
| 粒度 | 血缘侧计数 | 元数据侧计数 |
|---|---|---|
| Schema | schemaInLineage | schemaInMetadata |
| 表 | tableInLineage | tableInMetadata |
| 字段 | columnInLineage | columnInMetadata |
先确认命名空间和统计粒度,再与资源同步和采集范围核对。上述计数不能单独证明每个对象已一一正确匹配;覆盖率使用页面或目标接口明确提供的口径,不根据字段名称自行拼出百分比。
根据标签查关联对象
路径:/tag/getByTag。Query 参数 tagId 必填,类型为 Long。使用实际标签 ID,不以标签名称代替。结果用于查找已关联对象;查询本身不会为对象添加标签,也不会发起标签扩散。
响应与异常检查
| HTTP 状态 | 原接口说明 | 调用方的检查 |
|---|---|---|
| 200 | 请求成功 | 继续核对业务内容、范围及结果字段 |
| 400 | 参数错误 | 参数位置、必填项、类型、枚举及对象标识 |
| 401 | 认证失败 | 当前认证信息与访问权限,不重复提交无效凭据 |
| 404 | 路径或资源不存在 | 基础路径、对象是否存在及访问范围 |
| 500 | 服务异常 | 保存时间、接口及必要的错误摘要,由服务管理员检查 |
接口联调记录应包含请求范围、对象标识、响应状态和业务结果,不记录真实 Token 或密钥。页面能打开、HTTP 返回成功和业务关系正确需要分别核对。
