GetMetaTableLineage - - Alibaba Cloud Documentation Center

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 unique identifier of the table.
Direction	String	Yes	up	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.
NextPrimaryKey	String	No	odps.engine_name.table_name1	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.
PageSize	Integer	No	10	The number of entries per page. Valid values: 1 to 100. Default value: 10.
ClusterId	String	No	abc	The ID of the E-MapReduce (EMR) cluster. Configure this parameter only if you want to query the lineage of an EMR table.
DatabaseName	String	No	abc	The name of the database.
TableName	String	No	abc	The name of the table.
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 returned.
ErrorMessage	String	The connection does not exist.	The error message returned.
RequestId	String	0bc1ec92159376	The request ID.
Success	Boolean	true	Indicates whether the request was successful.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	The error code returned.
Data	Object		The business data.
NextPrimaryKey	String	odps.tt.2	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.
HasNext	Boolean	true	Indicates whether the next page exists.
DataEntityList	Array of DataEntityList		The information about the table.
TableName	String	name	The name of the table.
TableGuid	String	odps.tt.name	The unique identifier of the table.
CreateTimestamp	Long	1638720736000	The time when the table was created.
DatabaseName	String	db1	The name of the database.

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>
            <DatabaseName>db1</DatabaseName>
        </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,
      "DatabaseName" : "db1"
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Meta.TableNotExist	The table does not exist.	The table does not exist.
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	The values specified for one or more request parameters are invalid.
400	InvalidParameter.Meta.GuidFormat	The GUID format is invalid.	The GUID format is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	The values specified for one or more parameters of the application are invalid.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.	The date format is invalid.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	The value of the parameter for paging is invalid.
400	InvalidParameter.Meta.NotExist	The object does not exist.	The object that you query does not exist.
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.	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 system has failed to obtain the compute engine instance based on the MaxCompute project {0}.
403	ResourceNotAuthorized.Api	You are not authorized to access the resources.	You are not authorized to access the resources.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	The current user is not a tenant owner.
429	Throttling.Api	The request for this resource has exceeded your available limit.	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 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 DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	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.	An internal error has occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	The network cannot be connected.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	An unknown error has occurred.

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

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