ListLineageRelationships - DataWorks - Alibaba Cloud Documentation Center

Queries the lineage between two entities, such as tables, fields, and Object Storage Service (OSS) files, in Data Map.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:ListLineageRelationships	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
SrcEntityId	string	Yes	The source entity ID. For more information, see the table ID or field ID in the response returned by the ListTables or ListColumns operation. You can also specify a custom entity ID.	maxcompute-table:123456XXX::test_project::test_tbl dlf-table:123456XXX:test_catalog:test_db::test_tbl hms-table:c-abc123xxx::test_db::test_tbl holo-table:h-abc123xxx::test_db:test_schema:test_tbl custom-api:api123 custom-table:table456
DstEntityId	string	Yes	The destination entity ID. For more information, see the table ID or field ID in the response returned by the ListTables or ListColumns operation. You can also specify a custom entity ID.	maxcompute-table:123456XXX::test_project::test_tbl dlf-table:123456XXX:test_catalog:test_db::test_tbl hms-table:c-abc123xxx::test_db::test_tbl holo-table:h-abc123xxx::test_db:test_schema:test_tbl custom-api:api123 custom-table:table456
SrcEntityName	string	No	The source entity name. Supports fuzzy matching.	srcName
DstEntityName	string	No	The destination entity name. Supports fuzzy matching.	dstName
SortBy	string	No	The sort field. Default value: Name.	Name
Order	string	No	The order in which schemas are sorted. Default value: Asc. Valid values: Asc: ascending. Desc: descending.	Asc
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. Used for locating and troubleshooting issues.	SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination result.
TotalCount	long	The total count.	123
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
LineageRelationships	array	The list of data tables.
LineageRelationships	LineageRelationship	The lineage structure.

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.