ListLineages-阿里云帮助中心

Queries the upstream and downstream entities for a specified entity in Data Map. You can optionally include detailed lineage relationship information.

Operation description

To use this API, you must purchase DataWorks Standard Edition or a later edition.
Use this API to query the upstream and downstream entities of a specific entity and their lineage relationships.

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 ID of the source entity. This can be a table or column ID returned by the `ListTables` or `ListColumns` API, or the ID of a custom entity.	maxcompute-table:::project_name:[schema_name]:table_name
DstEntityId	string	No	The ID of the destination entity. This can be a table or column ID returned by the `ListTables` or `ListColumns` API, or the ID of a custom entity.	dlf-table::catalog_id:database_name::table_name
SrcEntityName	string	No	The name of the source entity. This parameter supports fuzzy matching.	srcName1
DstEntityName	string	No	The name of the destination entity. This parameter supports fuzzy matching.	dstName1
NeedAttachRelationship	boolean	No	Specifies whether to include lineage relationships. Default: false.	false
SortBy	string	No	The field to sort the results by. The default is `Name`, which sorts by entity name.	Name
Order	string	No	The sort order. Default: `Asc`. Valid values: `Asc`: ascending `Desc`: descending	Asc
PageNumber	integer	No	The page number to retrieve. Default: 1.	1
PageSize	integer	No	The number of entries per page. Default: 10. Maximum: 100.	10

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	0000-ABCD-EFG****
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination details.
TotalCount	integer	The total number of entries.	12
PageNumber	integer	The page number of the returned data.	1
PageSize	integer	The number of entries returned on the current page.	10
Lineages	array<object>	A list of lineage information.
	object	A lineage entry.
SrcEntity	LineageEntity	The source entity.
DstEntity	LineageEntity	The destination entity.
Relationships	array	A list of lineage relationships.
	LineageRelationship	A lineage relationship.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.