Queries the lineage of a metatable.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:* | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| TableGuid | string | Yes | The unique identifier of the table. | odps.engine_name.table_name |
| Direction | string | Yes | 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 |
| NextPrimaryKey | string | No | 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 |
| PageSize | integer | No | The number of entries per page. Default value: 10. Maximum value: 100. | 10 |
| ClusterId | string | No | The ID of the E-MapReduce (EMR) cluster. Configure this parameter only if you want to query the lineage of an EMR table. | abc |
| DatabaseName | string | No | The name of the database. | abc |
| TableName | string | No | The name of the table. | abc |
| DataSourceType | string | No | The type of the data source. Valid values: odps and emr. | emr |
Response parameters
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 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.GuidFormat | The GUID format is invalid. | The GUID format 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. | - |
| 400 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | - |
| 400 | InternalError.Meta.NoCalcEngine | An error occurred while retrieving the compute engine based on the MaxCompute project. | Incorrect project entered by user |
| 403 | Forbidden.Access | Access is forbidden. Activate DataWorks first. | - |
| 403 | ResourceNotAuthorized.Api | You are not authorized to access the resources. | - |
| 403 | Forbidden.Meta.NoTenant | The user is not the owner of any tenants. | The user is not the owner of any tenants. |
| 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. | - |
| 500 | InternalError.System | An internal system error occurred. Try again later. | - |
| 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-03-02 | The Error code has changed. The response structure of the API has changed | View Change Details |
