GetMetaColumnLineage-DataWorks(DataWorks)-阿里云帮助中心

Queries the lineage of a field in a metatable.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ColumnGuid	string	No	The unique identifier of the field.	odps.engine_name.table_name.column_name
Direction	string	Yes	The lineage direction. Valid values: up (ancestor lineage) and down (descendant lineage).	up
PageNum	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Maximum value: 100.	10
ClusterId	string	No	The ID of the E-MapReduce (EMR) cluster. Required only when querying data in an EMR compute engine instance.	abc
DatabaseName	string	No	The name of the database.	abc
TableName	string	No	The name of the metatable.	abc
ColumnName	string	No	The name of the field.	abc
DataSourceType	string	No	The type of the data source. Valid values: odps and emr.	emr

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID.	0bc1ec92159376
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Data	object	The lineage data.
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	integer	The total number of fields.	20
DataEntityList	array<object>	The lineage entries.
	object
ColumnGuid	string	The unique identifier of the field.	odps.engine_name.table_name.1
ColumnName	string	The name of the field.	1
TableName	string	The name of the table.	abc
DatabaseName	string	The name of the database.	abc
ClusterId	string	The EMR cluster ID.	abc

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1ec92159376",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 20,
    "DataEntityList": [
      {
        "ColumnGuid": "odps.engine_name.table_name.1",
        "ColumnName": "1",
        "TableName": "abc",
        "DatabaseName": "abc",
        "ClusterId": "abc"
      }
    ]
  }
}

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 request parameter is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	The app guid parameter is 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 parameter for paging is invalid.
400	InvalidParameter.Meta.NotExist	The object does not exist.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	Failed to connect to the interface network.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	An unknown error occurred while processing your request.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	The user is not the owner of any tenants.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.