ListLineageRelationships - 查詢資料地圖血緣關係列表

更新時間:
Copy as MD

查詢資料地圖給定兩實體(表、欄位、oss檔案等)之間的血緣關係資訊列表。

介面說明

  1. 需要購買 DataWorks 標準版及以上版本才能使用。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListLineageRelationships

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

源實體名稱,模糊比對。

srcName

DstEntityName

string

目標實體名稱,模糊比對。

dstName

SortBy

string

排序欄位,預設為 Name。

Name

Order

string

排序方向,預設為 Asc,枚舉值,當前支援:

  • Asc:升序

  • Desc:降序

Asc

PageNumber

integer

分頁頁碼,預設為 1。

1

PageSize

integer

分頁大小,預設為 10,最大為 100。

10

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求的 ID。用於定位排查問題。

SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF

Success

boolean

請求是否成功。

true

PagingInfo

object

分頁結果。

TotalCount

integer

總數。

123

PageNumber

integer

頁數,用於翻頁。

1

PageSize

integer

分頁大小。

10

LineageRelationships

array

資料表列表。

LineageRelationship

血緣關係結構體。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 123,
    "PageNumber": 1,
    "PageSize": 10,
    "LineageRelationships": [
      {
        "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"
          }
        },
        "Task": {
          "Id": "12345",
          "Type": "custom-sql",
          "Attributes": {
            "key": "key1:value21"
          }
        },
        "Id": "maxcompute-table.p.table:custom-table.xxx:custom-sql.123",
        "CreateTime": 1743040581000
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情