All Products
Search
Document Center

DataWorks:GetMetaTableLineage

Last Updated:Jan 08, 2026

Queries the lineage of a metatable.

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*get
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TableGuidstringYes

The unique identifier of the table.

odps.engine_name.table_name
DirectionstringYes

Specifies the ancestor or descendant lineage that you want to query for a field. Valid values: up and down. The value up indicates the ancestor lineage. The value down indicates the descendant lineage.

up
NextPrimaryKeystringNo

The logic of paging. Configure this parameter based on the value of the response parameter NextPrimaryKey when the value of the response parameter HasNext is true in the previous request.

odps.engine_name.table_name1
PageSizeintegerNo

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

10
ClusterIdstringNo

The ID of the E-MapReduce (EMR) cluster. Configure this parameter only if you want to query the lineage of an EMR table.

abc
DatabaseNamestringNo

The name of the database.

abc
TableNamestringNo

The name of the table.

abc
DataSourceTypestringNo

The type of the data source. Valid values: odps and emr.

emr

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

HttpStatusCodeinteger

The HTTP status code.

200
ErrorMessagestring

The error message.

The connection does not exist.
RequestIdstring

The request ID.

0bc1ec92159376
Successboolean

Indicates whether the request was successful.

true
ErrorCodestring

The error code.

Invalid.Tenant.ConnectionNotExists
Dataobject

The business data.

NextPrimaryKeystring

The logic of paging. If the value true is returned for the HasNext parameter and a value is returned for the NextPrimaryKey parameter in the response of the previous request, you must use the value of the NextPrimaryKey parameter for the next request.

odps | retail_e_commerce_2 | retail_e_commerce_2 | dws_ec_trd__cate_commodity_gmv_kpy_fy
HasNextboolean

Indicates whether the next page exists.

true
DataEntityListarray<object>

The information about the table.

DataEntityListobject
TableNamestring

The name of the table.

name
TableGuidstring

The unique identifier of the table.

odps.tt.name
CreateTimestamplong

The time when the table was created.

1638720736000
DatabaseNamestring

The name of the database.

db1

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "NextPrimaryKey": "odps | retail_e_commerce_2 | retail_e_commerce_2 | dws_ec_trd__cate_commodity_gmv_kpy_fy",
    "HasNext": true,
    "DataEntityList": [
      {
        "TableName": "name",
        "TableGuid": "odps.tt.name",
        "CreateTimestamp": 1638720736000,
        "DatabaseName": "db1"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.Meta.TableNotExistThe table does not exist.The table does not exist.
400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.The request parameter is invalid.
400InvalidParameter.Meta.GuidFormatThe GUID format is invalid.The GUID format is invalid.
400InvalidParameter.Meta.IllegalThe app guid parameter is invalid.The app guid parameter is invalid.
400InvalidParameter.Meta.IllegalDateThe date format is invalid.The date format is invalid.
400InvalidParameter.Meta.IllegalPageErrorThe parameter for paging is invalid.The parameter for paging is invalid.
400InvalidParameter.Meta.NotExistThe object does not exist.-
400InternalError.UserId.MissingAn internal system error occurred. Try again later.-
400InternalError.Meta.NoCalcEngineAn error occurred while retrieving the compute engine based on the MaxCompute project.Incorrect project entered by user
403Forbidden.AccessAccess is forbidden. Activate DataWorks first.-
403ResourceNotAuthorized.ApiYou are not authorized to access the resources.-
403Forbidden.Meta.NoTenantThe user is not the owner of any tenants.The user is not the owner of any tenants.
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.Meta.TenantTimeOutFailed to connect to the interface network.Failed to connect to the interface network.
500InternalError.Meta.UnknownAn unknown error occurred while processing your request.An unknown error occurred while processing your request.

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

Change history

Change timeSummary of changesOperation
2023-03-02The Error code has changed. The response structure of the API has changedView Change Details