All Products
Search
Document Center

DataWorks:ListLineage

Last Updated:Jan 11, 2024

Queries the ancestor or descendant lineages of an entity.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes ListLineage

The operation that you want to perform. Set the value to ListLineage.

EntityQualifiedName String Yes maxcompute-table.project.table

The unique identifier of the entity.

NextToken String No next-token-from-previous-request

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

Keyword String No name-keyword

The keyword of the entity name.

Direction String Yes up

The lineage type. Valid values:

  • up: ancestor lineage
  • down: descendant lineage
PageSize Integer No 10

The number of entries per page. Maximum value: 100.

Response parameters

Parameter

Type

Example

Description

HttpStatusCode Integer 200

The HTTP status code.

ErrorMessage String qualifiedName should be in format as entity-table.entity-guid

The error message.

RequestId String 64B-587A-8CED-969E1973887FXXX-TT

The request ID. You can locate logs and troubleshoot issues based on the ID.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true
  • false
ErrorCode String 1010040007

The error code.

Data Object

The structure returned.

NextToken String nextTokenFromRequest-xxxsd-ff

The pagination token that is used in the next request to retrieve a new page of results.

DataEntityList Array of Entity

The array of the entity structure.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListLineage
&EntityQualifiedName=maxcompute-table.project.table
&NextToken=next-token-from-previous-request
&Keyword=name-keyword
&Direction=up
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListLineageResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>qualifiedName should be in format as entity-table.entity-guid</ErrorMessage>
    <RequestId>64B-587A-8CED-969E1973887FXXX-TT</RequestId>
    <Success>true</Success>
    <ErrorCode>1010040007</ErrorCode>
    <Data>
        <NextToken>nextTokenFromRequest-xxxsd-ff</NextToken>
        <DataEntityList>
            <Entity>
                <QualifiedName>maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23</QualifiedName>
                <TenantId>12345</TenantId>
            </Entity>
            <CreateTimestamp>1686215809269</CreateTimestamp>
            <RelationList>
                <Guid>aaabbccddguid</Guid>
                <Datasource>mysql</Datasource>
                <Type>sql</Type>
                <Channel>THIRD_PARTY</Channel>
            </RelationList>
        </DataEntityList>
    </Data>
</ListLineageResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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
      },
      "CreateTimestamp" : 1686215809269,
      "RelationList" : {
        "Guid" : "aaabbccddguid",
        "Datasource" : "mysql",
        "Type" : "sql",
        "Channel" : "THIRD_PARTY"
      }
    }
  }
}

Error codes

For a list of error codes, see Service error codes.