Trace Entity Data Lineage via ListLineageRelationships - DataWorks - Alibaba Cloud - DataWorks

Operation description

DataWorks Basic Edition or a higher edition is required.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListLineageRelationships

list

*All Resource

*

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:::project_name:[schema_name]:table_name
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.	dlf-table::catalog_id:database_name::table_name
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 elements

Element	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	integer	The total count.	123
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
LineageRelationships	array	The list of data tables.
	LineageRelationship	The lineage structure.

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.