ListLineages-阿里云帮助中心

Queries the upstream and downstream lineage entities for a specified entity in Data Map, with an option to include detailed lineage relationship information.

Operation description

You must purchase DataWorks Standard Edition or a more advanced edition to use this operation.
This operation queries the upstream and downstream entities of the current entity and the lineage relationships between the entities.

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:ListLineages

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SrcEntityId	string	No	The source entity ID. You can refer to the table or column ID returned by the ListTables or ListColumns operation, or use a custom entity ID.	maxcompute-table:::project_name:[schema_name]:table_name
DstEntityId	string	No	The destination entity ID. You can refer to the table or column ID returned by the ListTables or ListColumns operation, or use a custom entity ID.	dlf-table::catalog_id:database_name::table_name
SrcEntityName	string	No	The source entity name. Fuzzy matching is supported.	srcName1
DstEntityName	string	No	The destination entity name. Fuzzy matching is supported.	dstName1
NeedAttachRelationship	boolean	No	Specifies whether to return lineage relationship information. Default value: false.	false
SortBy	string	No	The sort field. Default value: Name. The entities are sorted by lineage entity name. Valid values: Name : By name.	Name
Order	string	No	The sort order. Default value: Asc. Valid values: Asc: Ascending order. Desc: Descending order. Valid values: Asc : Ascending order. Desc : Descending order.	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
RecentDays	integer	No	Queries the lineage relationships that take effect within the specified number of recent calendar days. Valid values: 1 to 30. For example, 1 indicates starting from midnight of the current day, and 7 indicates starting from midnight 6 days ago. If this parameter is not specified, the system filters the data based on the configured lineage validity period.	7

Response elements

Element	Type	Description	Example
	object	The response.
PagingInfo	object	The pagination information.
Lineages	array<object>	The lineage information list.
	object	The lineage information.
DstEntity	LineageEntity	The destination entity.
Relationships	array	The lineage relationship information.
	LineageRelationship	The lineage relationship information.
SrcEntity	LineageEntity	The source entity.
PageNumber	integer	The requested page number, which is used for pagination.	1
PageSize	integer	The number of entries per page. Default value: 10.	10
TotalCount	integer	The total number of entries.	12
RequestId	string	The request ID.	0000-ABCD-EFG****
Success	boolean	Indicates whether the request is successful.	true

Examples

Success response

JSON format

{
  "PagingInfo": {
    "Lineages": [
      {
        "DstEntity": {
          "Id": "maxcompute-table:::project_name:[schema_name]:table_name",
          "Name": "test_tbl",
          "Attributes": {
            "key": "value"
          }
        },
        "Relationships": [
          {
            "SrcEntity": {
              "Id": "maxcompute-table:::project_name:[schema_name]:table_name",
              "Name": "test_tbl",
              "Attributes": {
                "key": "value"
              }
            },
            "DstEntity": {
              "Id": "maxcompute-table:::project_name:[schema_name]:table_name",
              "Name": "test_tbl",
              "Attributes": {
                "key": "value"
              }
            },
            "Task": {
              "Id": "12345",
              "Type": "custom-sql",
              "Attributes": {
                "key": "value"
              }
            },
            "Id": "maxcompute-table.p.table:custom-table.xxx:custom-sql.123",
            "CreateTime": 1743040581000
          }
        ]
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 12
  },
  "RequestId": "0000-ABCD-EFG****",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.