Creates a lineage between a source entity and a destination entity. Either the source or destination entity must be a custom entity.
Operation description
-
DataWorks Professional Edition or a higher edition is required.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SrcEntity | LineageEntity |
No |
The source entity. |
|
| DstEntity | LineageEntity |
No |
The destination entity. |
|
| Task | LineageTask |
No |
The task information. |
Entity object (SrcEntity / DstEntity)
Defines the source and destination of a lineage relationship. When registering as a custom entity, the parameter requirements are as follows:
| Parameter | Type | Required | Description |
| Id | String | Yes | Custom entity identifier, unique within the tenant. Format: custom-{Type}:{Identifier}.- Type: The entity type (letters, digits, and underscores; up to 64 characters).- Identifier: The entity identifier (letters, digits, and underscores; up to 64 characters). |
| Name | String | Yes | Entity name (letters, digits, and underscores; up to 64 characters). |
| Attributes | Map | No | Custom attributes. Up to 20 attributes are supported. - Key: The attribute name (letters, digits, and underscores; up to 64 characters). - Value: The attribute value (up to 128 characters). |
Custom entity example:
{
"Id": "custom-report:report_001",
"Name": "report_001",
"Attributes": {
"Owner": "zhangsan",
"Department": "Sales"
}
}
Task information (Task)
Describes the job or task that produces the lineage relationship.
| Parameter | Type | Required | Description |
| Id | String | Yes | Unique task identifier. Consists of letters, digits, and underscores; up to 64 characters. |
| Type | String | Yes | Task type. Format: custom-{RawType}.- RawType: The task type definition (letters, digits, and underscores; up to 64 characters). |
| Attributes | Map | No | Custom task attributes. Up to 20 attributes are supported. - Key: The attribute name (letters, digits, and underscores; up to 64 characters). - Value: The attribute value (up to 128 characters). |
Task information example:
{
"Id": "task_handler_89a6sda",
"Type": "custom-hive_sql",
"Attributes": {
"Cluster": "Production_Cluster",
"RetryTimes": "3"
}
}
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| RequestId |
string |
The request ID. The unique identifier of a request. |
C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490 |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Id |
string |
The lineage ID. |
4as3dasf654a |
Examples
Success response
JSON format
{
"RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490",
"Success": true,
"Id": "4as3dasf654a"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.