調用CreateLineageRelationship API註冊資料地圖血緣關係-巨量資料開發治理平台 DataWorks-阿里雲 -

註冊資料地圖的血緣關係。透過此介面，可以在 DataWorks 納管元資料實體之間建立血緣關係，包括表與表、欄位與欄位、表與欄位、資料集與表等場景；也可以在納管實體與使用者自行註冊的自訂實體物件之間建立血緣關係。介面相容非納管自訂物件，但該方式已不再推薦。呼叫前需確保參與血緣註冊的納管實體已存在於 DataWorks 平台。

介面說明

需要購買 DataWorks 專業版及以上版本才能使用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
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 或 List API 返回的 Id。
對於自訂物件，推薦使用使用者註冊的自訂實體物件方式，需要先完成實體定義和實體物件註冊：
1. 呼叫 CreateMetaEntityDef 建立自訂實體定義。
2. 呼叫 BatchCreateMetaEntities 建立具體實體物件。
3. 使用 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` 註冊血緣。

```json
{
  "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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。