全部產品
Search
文件中心

DataWorks:ListLineages

更新時間:Sep 03, 2026

查詢 DataWorks 資料地圖中指定實體的上游與下游血緣實體,並可選擇是否包含詳細的血緣關係資訊。

介面說明

  1. You must purchase DataWorks Standard Edition or a higher edition to use this operation.

  2. This operation queries the upstream and downstream entities of the current entity, as well as the lineage relationships between entities.

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListLineages

list

*全部資源。

*

無 無

請求參數

名稱

類型

必填

描述

樣本值

SrcEntityId

string

否

The source entity ID. You can use the table or column ID returned by the ListTables or ListColumns operation, or a custom entity ID.

maxcompute-table:::project_name:[schema_name]:table_name

DstEntityId

string

否

The destination entity ID. You can use the table or column ID returned by the ListTables or ListColumns operation, or a custom entity ID.

dlf-table::catalog_id:database_name::table_name

SrcEntityName

string

否

The source entity name. Fuzzy match is supported.

srcName1

DstEntityName

string

否

The destination entity name. Fuzzy match is supported.

dstName1

NeedAttachRelationship

boolean

否

Specifies whether to return lineage relationship information. Default value: false.

false

SortBy

string

否

The sort field. Default value: Name, which sorts by lineage entity name.

Name

Order

string

否

The sort direction. Default value: Asc. Valid values:

  • Asc: ascending order.

  • Desc: descending order.

枚舉值:

  • Asc :

    Ascending order.

  • Desc :

    Descending order.

Asc

PageNumber

integer

否

The page number. Default value: 1.

1

PageSize

integer

否

The page size. Default value: 10. Maximum value: 100.

10

RecentDays

integer

否

返回參數

名稱

類型

描述

樣本值

object

The response parameters.

RequestId

string

The request ID.

0000-ABCD-EFG****

Success

boolean

Indicates whether the request was successful.

true

PagingInfo

object

The paging result.

TotalCount

integer

The total number of entries.

12

PageNumber

integer

The page number of the returned data, used for pagination.

1

PageSize

integer

The page size. Default value: 10.

10

Lineages

array<object>

The lineage information list.

object

The lineage information.

SrcEntity LineageEntity

The source entity.

DstEntity LineageEntity

The destination entity.

Relationships

array

The lineage relationship information.

LineageRelationship

The lineage relationship information.

樣本

正常返回樣本

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
          }
        ]
      }
    ]
  }
}

錯誤碼

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

變更歷史

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