ListLineage - DataWorks - Alibaba Cloud Documentation Center

Queries the ancestor or descendant lineage of an entity.

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:
- The required resource types are displayed in bold characters.
- 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:*	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
EntityQualifiedName	string	Yes	The unique identifier of the entity.	maxcompute-table.project.table
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	next-token-from-previous-request
Keyword	string	No	The keyword of the entity name.	name-keyword
Direction	string	Yes	The lineage type. Valid values: up: ancestor lineage down: descendant lineage	up
PageSize	integer	No	The number of entries per page. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	OpenApiMetaResultModel
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	qualifiedName should be in format as entity-table.entity-guid
RequestId	string	The request ID.	64B-587A-8CED-969E1973887FXXX-TT
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	1010040007
Data	object	The structure returned.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	nextTokenFromRequest-xxxsd-ff
DataEntityList	array<object>	The array of the entity structure.
DataEntityList	object
Entity	Entity	The information about the entity.
CreateTimestamp	long	The time when the lineage was generated.	1686215809269
RelationList	array<object>	The array of the relationship structure.
RelationList	object
Guid	string	The unique relationship ID.	aaabbccddguid
Datasource	string	The name of the data source.	mysql
Type	string	The task type, which is used to describe the relationship between entities, such as SQL-based calculation, mapping based on report fields, or API operation definition.	sql
Channel	string	The data channel. Valid values: `FIRST_PARTY: DataWorks platformTHIRD_PARTY: user registration`	THIRD_PARTY

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "qualifiedName should be in format as entity-table.entity-guid",
  "RequestId": "64B-587A-8CED-969E1973887FXXX-TT",
  "Success": true,
  "ErrorCode": "1010040007",
  "Data": {
    "NextToken": "nextTokenFromRequest-xxxsd-ff",
    "DataEntityList": [
      {
        "Entity": {
          "QualifiedName": "maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23",
          "TenantId": 12345,
          "EntityContent": {
            "test": "test",
            "test2": 1
          }
        },
        "CreateTimestamp": 1686215809269,
        "RelationList": [
          {
            "Guid": "aaabbccddguid",
            "Datasource": "mysql",
            "Type": "sql",
            "Channel": "THIRD_PARTY"
          }
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history