注册数据地图的血缘关系。通过此接口,可以在 DataWorks 纳管元数据实体之间建立血缘关系,包括表与表、字段与字段、表与字段、数据集与表等场景;也可以在纳管实体与用户自行注册的自定义实体对象之间建立血缘关系。接口兼容非纳管自定义对象,但该方式已不再推荐。调用前需确保参与血缘注册的纳管实体已存在于 DataWorks 平台。
接口说明
需要购买 DataWorks 专业版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SrcEntity | LineageEntity |
否 |
源实体 。 |
|
| DstEntity | LineageEntity |
否 |
目标实体 。 |
|
| Task | LineageTask |
否 |
任务信息 。 |
实体对象 (SrcEntity / DstEntity)
用于描述血缘关系的源端和目标端,支持在以下类型的实体之间注册血缘关系:
| 实体类型 | 是否需要提前注册实体 | Id 获取方式 | 说明 |
| DataWorks 已采集表 | 否 | 调用 ListTables 或 GetTable,使用返回结果中的 Id | 适用于 DataWorks 平台已采集到的表或用户自己注册的扩展表。 |
| DataWorks 已采集字段 | 否 | 调用 ListColumns 或 GetColumn,使用返回结果中的 Id | 已采集表对应的字段。 |
| 数据集 | 否,若数据集已存在;创建新数据集时需先调用 CreateDataset | 调用 CreateDataset、ListDatasets 或 GetDataset,使用返回结果中的 Id | 适用于 DataWorks 数据集实体。 |
| 数据集版本 | 否,若版本已存在;创建新版本时需先调用 CreateDatasetVersion | 调用 CreateDatasetVersion、ListDatasetVersions 或 GetDatasetVersion,使用返回结果中的 Id | 适用于数据集的具体版本。 |
| 用户注册的自定义实体对象 | 是 | 先调用 CreateMetaEntityDef 创建自定义实体定义,再调用 BatchCreateMetaEntities 创建实体对象,使用返回结果中的 Id | 适用于需要在 DataWorks 中纳管和查询的自定义实体。 |
| 非纳管自定义对象(不推荐) | 否 | 调用方自行指定以 custom- 开头的 Id,格式为 custom-{Type}:{Identifier} | 兼容历史用法,目前已不再推荐。对于外部报表、第三方系统对象等自定义对象,更建议先注册为 DataWorks 自定义实体对象后再注册血缘。 |
补充说明:
对于 DataWorks 已采集到的表、字段、数据集、数据集版本,建议不要手动拼接
Id,应优先使用对应Get或ListAPI 返回的Id。- 对于自定义对象,推荐使用用户注册的自定义实体对象方式,需要先完成实体定义和实体对象注册:
调用
CreateMetaEntityDef创建自定义实体定义。调用
BatchCreateMetaEntities创建具体实体对象。使用
BatchCreateMetaEntities返回的实体Id作为SrcEntity.Id或DstEntity.Id。
对于非纳管自定义对象,不需要调用
CreateMetaEntityDef或BatchCreateMetaEntities。只需传入以custom-开头的实体Id,并填写Name。该方式主要用于兼容历史场景,目前已不再推荐;新接入场景建议使用注册自定义实体对象的方式,便于后续查询、管理和扩展自定义属性。SrcEntity.Attributes和DstEntity.Attributes表示实体端点的扩展属性;血缘关系本身的属性请放在Task.Attributes中。
任务信息 (Task)
用于描述产生该血缘关系的作业或任务信息。
| 参数名称 | 类型 | 是否必选 | 描述 |
| Id | String | 否 | 任务唯一标识。建议必传稳定值,便于幂等注册、查询和删除。仅支持字母、数字、下划线,长度不超过 64。 |
| Type | String | 是 | 任务类型。必须以 custom- 开头,仅支持字母、数字、下划线、连字符,长度不超过 64。 |
| Attributes | Map<String,String> | 否 | 任务属性,最多支持 20 个属性,复杂值需序列化为 JSON 字符串。 • Key: 属性名(字母/数字/下划线,≤64 字符) • Value: 属性值(≤128 字符)。 |
请求示例
DataWorks 已采集表与自定义实体对象
{
"SrcEntity": {
"Id": "custom_entity-customer_api:api_001",
"Name": "api_001"
},
"DstEntity": {
"Id": "mysql-table:rm-xxx::demo_db::demo_table",
"Name": "demo_table"
},
"Task": {
"Id": "api_to_table_001",
"Type": "custom-lineage-task",
"Attributes": {
"scene": "api_to_table",
"owner": "zhangsan"
}
}
}
非纳管自定义对象与 DataWorks 已采集表
该方式主要用于兼容历史用法,目前已不再推荐。新接入场景建议先通过 CreateMetaEntityDef 和 BatchCreateMetaEntities 注册自定义实体对象,再使用返回的实体 Id 注册血缘。
{
"SrcEntity": {
"Id": "custom-report:report_001",
"Name": "report_001"
},
"DstEntity": {
"Id": "maxcompute-table:::demo_project:default:demo_table",
"Name": "demo_table"
},
"Task": {
"Id": "report_to_table_001",
"Type": "custom-lineage-task",
"Attributes": {
"scene": "report_to_table"
}
}
}
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID, 一次请求的唯一标识。 |
C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490 |
| Success |
boolean |
请求是否成功。 |
true |
| Id |
string |
血缘关系 ID。 |
4as3dasf654a |
示例
正常返回示例
JSON格式
{
"RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490",
"Success": true,
"Id": "4as3dasf654a"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。