Queries the lineage of a metatable.

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 GetMetaTableLineage

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

TableGuid String Yes odps.engine_name.table_name

The GUID of the metatable.

Direction String Yes up

Specifies whether to query the ancestor or descendant lineage of the field. The value up indicates the ancestor lineage. The value down indicates the descendant lineage.

NextPrimaryKey String No odps.engine_name.table_name1

The logic of paging. Set this parameter based on the value of the response parameter NextPrimaryKey when the value of the response parameter HasNext is true in the last query.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

RegionId String Yes cn-shanghai

The region ID.

ClusterId String No abc

The ID of the E-MapReduce (EMR) cluster. Set this parameter only when you query data in an EMR compute engine instance.

DatabaseName String No abc

The name of the metadatabase.

TableName String No abc

The name of the metatable.

DataSourceType String No emr

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

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code.

ErrorMessage String The connection does not exist.

The error message.

RequestId String 0bc1ec92159376

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code.

Data Object

The business data.

NextPrimaryKey String odps.tt.2

The paging information.

HasNext Boolean true

Indicates whether the next page has more query results.

DataEntityList Array of DataEntityList

The information about the metatable.

TableName String name

The name of the metatable.

TableGuid String odps.tt.name

The GUID of the metatable.

CreateTimestamp Long 1638720736000

The time when the metatable was created.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetMetaTableLineage
&TableGuid=odps.engine_name.table_name
&Direction=up
&NextPrimaryKey=odps.engine_name.table_name1
&PageSize=10
&ClusterId=abc
&DatabaseName=abc
&TableName=abc
&DataSourceType=emr
&<Common request parameters>

Sample success responses

XML format

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

<GetMetaTableLineageResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0bc1ec92159376</RequestId>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Data>
        <NextPrimaryKey>odps.tt.2</NextPrimaryKey>
        <HasNext>true</HasNext>
        <DataEntityList>
            <TableName>name</TableName>
            <TableGuid>odps.tt.name</TableGuid>
            <CreateTimestamp>1638720736000</CreateTimestamp>
        </DataEntityList>
    </Data>
</GetMetaTableLineageResponse>

JSON format

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

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

Error codes

HTTP status code Error code Error message Description
400 Invalid.Meta.TableNotExist The table does not exist. The error message returned because the metatable does not exist.
400 InvalidParameter.Meta.CommonError The specified parameter is invalid. The error message returned because the values specified for one or more request parameters are invalid.
400 InvalidParameter.Meta.GuidFormat The GUID format is invalid. The error message returned because the GUID format is invalid.
400 InvalidParameter.Meta.Illegal The app guid parameter is invalid. The error message returned because the values specified for one or more parameters of the application are invalid.
400 InvalidParameter.Meta.IllegalDate The date format is invalid. The error message returned because the date format is invalid.
400 InvalidParameter.Meta.IllegalPageError The parameter for paging is invalid. The error message returned because the value of the parameter for paging is invalid.
400 InvalidParameter.Meta.NotExist The object does not exist. The error message returned because the object you query does not exist.
400 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
400 InternalError.Meta.NoCalcEngine An error occurred while retrieving the compute engine based on the MaxCompute project. The error message returned because the system has failed to obtain the compute engine instance based on the specified MaxCompute project.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. The error message returned because you are not authorized to access the resources.
403 Forbidden.Meta.NoTenant The user is not the owner of any tenants. The error message returned because the current user is not a tenant owner.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the number of requests per day for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.Meta.TenantTimeOut Failed to connect to the interface network. The error message returned because the network cannot be connected.
500 InternalError.Meta.Unknown An unknown error occurred while processing your request. The error message returned because an unknown error has occurred.

For a list of error codes, visit the API Error Center.

For more information about the example on how to use the GetMetaTableLineage operation, see Examples of DataWorks API operations.