CreateLineageRelationship - 注册数据地图血缘关系 - 大数据开发治理平台 DataWorks

注册数据地图的血缘关系，要求至少其中一方为自定义对象。通过此接口，可以将自定义对象（如外部报表、第三方系统表等）与 DataWorks 纳管元数据实体建立连接。

接口说明

需要购买 DataWorks 专业版及以上版本才能使用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述
SrcEntity	LineageEntity	否	源实体。
DstEntity	LineageEntity	否	目标实体。
Task	LineageTask	否	任务信息。

实体对象 (SrcEntity / DstEntity)

用于定义血缘关系的起点和终点。当作为自定义对象注册时，参数要求如下：

参数名称	类型	必填	描述
Id	String	是	自定义对象标识，租户内唯一。格式为 `custom-{Type}:{Identifier}`。 • `Type`: 对象类型（字母/数字/下划线，≤64 字符） • `Identifier`: 对象标识（字母/数字/下划线，≤64 字符）
Name	String	是	对象名称（字母/数字/下划线，≤64 字符）。
Attributes	Map	否	自定义属性。最多支持 20 个属性。 • Key: 属性名（字母/数字/下划线，≤64 字符） • Value: 属性值（≤128 字符）

自定义对象示例：

{
    "Id": "custom-report:report_001",
    "Name": "report_001",
    "Attributes": {
        "Owner": "zhangsan",
        "Department": "Sales"
    }
}

任务信息 (Task)

用于描述产生该血缘关系的作业或任务信息。

参数名称	类型	必填	描述
Id	String	是	任务唯一标识。由字母、数字、下划线组成，长度不超过 64 个字符。
Type	String	是	任务类型。格式为 `custom-{RawType}`。 • `RawType`: 任务定义的类型（字母/数字/下划线，≤64 字符）
Attributes	Map	否	任务自定义属性。最多支持 20 个属性。 • Key: 属性名（字母/数字/下划线，≤64 字符） • Value: 属性值（≤128 字符）

任务信息示例：

{
    "Id": "task_handler_89a6sda",
    "Type": "custom-hive_sql",
    "Attributes": {
        "Cluster": "Production_Cluster",
        "RetryTimes": "3"
    }
}

返回参数

名称	类型	描述	示例值
	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"
}

错误码

访问错误中心查看更多错误码。