全部產品
Search
文件中心

DataWorks:RegisterLineageRelation - 註冊血緣關係

更新時間:Mar 21, 2026

註冊實體關聯,支援使用者註冊自訂的實體關聯。

介面說明

本介面當前處於試用階段。需要體驗的使用者可以提出申請,管理員加入試用名單後即可調用。

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

LineageRelationRegisterVO LineageRelationRegisterVO

血緣註冊結構體。

實體唯一標識格式:EntityType.EntityGuid

1:EntityType 標識實體類型
    1.1 Dataworks 上已有的實體類型
        (1) maxcompute 表:maxcompute-table
        (2) mysql 表:mysql-table
        (3) emr 表:emr-table 
        (4) holo 表:holodb-table

    1.2 使用者自訂的實體類型: custom-xxx
       根據使用者需求,推薦使用如下類型
        (1) 表:custom-table
        (2) API:custom-api 
        (3) 應用:custom-app
        (4) 報表: custom-report
        (5) 資料集:custom-dataset
        (6) 資料來源:custom-datasource

2: EntityGuid:在同一實體類型內部,唯一標識該實體的標識
    使用者自訂的實體可以根據需要自己定義唯一 ID

3: 實體舉例:
    3.1:Dataworks 已有系統實體,可以在資料地圖頁面血緣圖中看到
        (1) maxcompute-table.project.tableName  表示 maxcompute 表的唯一 ID
        (2) emr-table.kadfdfaccdd4ted   表示 emr 表的唯一 ID
    3.2:用自訂實體: 使用者根據自己業務需求,自己定義出唯一 Id,(50 個位元組以內)
        (1) custom-api.listUser   表示自訂 api 實體,其唯一標識為 listUser 
        (2) custom-table.db1.table2  標識自訂表格實體,其唯一標識為 db1.table2

返回參數

名稱

類型

描述

樣本值

object

OpenApiMetaResultModel

HttpStatusCode

integer

HTTP 狀態代碼。

200

ErrorMessage

string

錯誤資訊。

The entity of lineage not exist, xxx

RequestId

string

請求的 ID:用於定位日誌、排查問題。

EE50E05E-028C-182B-****

Success

boolean

調用是否成功。取值如下:

  • true:調用成功。

  • false:調用失敗。

true

ErrorCode

string

錯誤碼。

1010210001

LineageRelation

object

血緣關聯性物件。

SrcEntityQualifiedName

string

源實體唯一標識。

maxcompute-table.project.table

DestEntityQualifiedName

string

目標實體唯一標識。

custom-report.month_stat_user

RelationshipGuid

string

實體間血緣關係 ID。

dfsldfdlsfdsaaaabbbb

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The entity of lineage not exist, xxx",
  "RequestId": "EE50E05E-028C-182B-****",
  "Success": true,
  "ErrorCode": "1010210001",
  "LineageRelation": {
    "SrcEntityQualifiedName": "maxcompute-table.project.table",
    "DestEntityQualifiedName": "custom-report.month_stat_user",
    "RelationshipGuid": "dfsldfdlsfdsaaaabbbb"
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情