ListLineage

Queries the upstream and downstream lineage relationships of an entity.

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

list

*All Resource

*

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 specifies the starting point of the current read operation.	next-token-from-previous-request
Keyword	string	No	The keyword of the entity name.	name-keyword
Direction	string	Yes	The lineage direction. Valid values: up: upstream. down: downstream.	up
PageSize	integer	No	The page size. Maximum value: 100.	10

Response elements

Element	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. Used to locate logs and troubleshoot issues.	64B-587A-8CED-969E1973887FXXX-TT
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code.	1010040007
Data	object	The response structure.
NextToken	string	The pagination token that specifies the starting point of the next read operation.	nextTokenFromRequest-xxxsd-ff
DataEntityList	array<object>	The array of entity structures.
	array<object>	The entity structure.
Entity	Entity	The entity information.
CreateTimestamp	integer	The time when the lineage was created.	1686215809269
RelationList	array<object>	The array of relation structures.
	object	The relation structure.
Guid	string	The unique ID of the relation.	aaabbccddguid
Datasource	string	The data source.	maxcompute,mysql
Type	string	The task type, which describes the relationship type between entities. For example, computed by SQL, mapped by report fields, or defined by API.	sql
Channel	string	The data channel. Valid values: FIRST_PARTY: DataWorks platform data. THIRD_PARTY: User-registered data.	THIRD_PARTY

Examples

Success response

JSON format

{
  "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": "maxcompute,mysql",
            "Type": "sql",
            "Channel": "THIRD_PARTY"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.