調用ListLineages查詢資料地圖實體血緣-巨量資料開發治理平台 DataWorks-阿里雲

查詢資料地圖中給定實體的上下遊血緣實體列表，是否包含具體的血緣關係資訊可選。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。
本介面主要查詢當前實體有哪些上/下遊實體，以及實體間的血緣關係

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListLineages

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
SrcEntityId	string	否	源實體 ID，可參考 ListTables / ListColumns 介面返回的表/欄位 ID，以及自訂實體 ID。	maxcompute-table:::project_name:[schema_name]:table_name
DstEntityId	string	否	目標實體 ID，可參考 ListTables / ListColumns 介面返回的表/欄位 ID，以及自訂實體 ID。	dlf-table::catalog_id:database_name::table_name
SrcEntityName	string	否	源實體名稱，模糊比對。	srcName1
DstEntityName	string	否	目標實體名稱，模糊比對。	dstName1
NeedAttachRelationship	boolean	否	是否返回血緣關係資訊，預設為 false。	false
SortBy	string	否	排序欄位，預設為 Name，按照血緣實體名稱排序。	Name
Order	string	否	排序方向，預設為 Asc，枚舉值，當前支援 Asc 升序 Desc 降序	Asc
PageNumber	integer	否	分頁頁碼，預設為 1。	1
PageSize	integer	否	分頁大小，預設為 10，最大為 100。	10

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	0000-ABCD-EFG****
Success	boolean	請求是否成功。	true
PagingInfo	object	分頁結果。
TotalCount	integer	總條數。	12
PageNumber	integer	請求的資料頁數，用於翻頁。	1
PageSize	integer	分頁大小，預設為 10。	10
Lineages	array<object>	血緣資訊列表。
	object	血緣資訊。
SrcEntity	LineageEntity	源實體。
DstEntity	LineageEntity	目標實體。
Relationships	array	血緣關係資訊。
	LineageRelationship	血緣關係資訊。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0000-ABCD-EFG****",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 12,
    "PageNumber": 1,
    "PageSize": 10,
    "Lineages": [
      {
        "SrcEntity": {
          "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "DstEntity": {
          "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "Relationships": [
          {
            "SrcEntity": {
              "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
              "Name": "test_tbl",
              "Attributes": {
                "key": "key1:value1"
              }
            },
            "Task": {
              "Id": "12345",
              "Type": "custom-sql",
              "Attributes": {
                "key": "key1:value21"
              }
            },
            "Id": "maxcompute-table.p.table:custom-table.xxx:custom-sql.123",
            "CreateTime": 1743040581000
          }
        ]
      }
    ]
  }
}

錯誤碼

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

變更歷史

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