RegisterLineageRelation - DataWorks - Alibaba Cloud Documentation Center

Registers the lineage between self-managed entities to DataWorks.

Operation description

This operation is in the trial phase. Users who need to call this operation can apply for it. The users can call this operation after the administrator adds the users to the trial list.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
LineageRelationRegisterVO	LineageRelationRegisterVO	Yes	The structure whose lineage you want to register to DataWorks.

Format of the unique identifier of an entity: EntityType.EntityGuid

1. The EntityType parameter identifies the type of an entity.
    1.1 Existing entity types in DataWorks
        (1) MaxCompute table: maxcompute-table
        (2) MySQL table: mysql-table
        (3) EMR table: emr-table
        (4) Hologres table: holodb-table

    1.2 Custom entity types: custom-xxx
       The following entity types are recommended based on user requirements:
        (1) Table: custom-table
        (2) API: custom-api
        (3) Application: custom-app
        (4) Report: custom-report
        (5) Dataset: custom-dataset
        (6) Data source: custom-datasource

2. The EntityGuid parameter specifies the unique identifier of an entity among multiple entities of the same type.
    Users can define the unique ID for a custom entity based on their business requirements.

3. Sample entity:
    3.1 The existing lineage between system entities in DataWorks can be viewed in lineage graphs on the Data Map page.
        (1) maxcompute-table.project.tableName specifies the unique ID of a MaxCompute table.
        (2) emr-table.kadfdfaccdd4ted specifies the unique ID of an E-MapReduce (EMR) table.
    3.2 Users can define the unique ID for a custom entity based on their business requirements. The unique ID cannot exceed 50 bytes in length.
        (1) custom-api.listUser: specifies a custom API entity. The unique identifier of the entity is listUser.
        (2) custom-table.db1.table2: specifies a custom table entity. The unique identifier of the entity is db1.table2.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The entity of lineage not exist, xxx
RequestId	string	The request ID.	EE50E05E-028C-182B-9xxx
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	1010210001
LineageRelation	object	The lineage.
SrcEntityQualifiedName	string	The unique identifier of the source entity.	maxcompute-table.project.table
DestEntityQualifiedName	string	The unique identifier of the destination entity.	custom-report.month_stat_user
RelationshipGuid	string	The ID of the lineage between entities.	dfsldfdlsfdsaaaabbbb

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The entity of lineage not exist, xxx",
  "RequestId": "EE50E05E-028C-182B-9xxx",
  "Success": true,
  "ErrorCode": "1010210001",
  "LineageRelation": {
    "SrcEntityQualifiedName": "maxcompute-table.project.table",
    "DestEntityQualifiedName": "custom-report.month_stat_user",
    "RelationshipGuid": "dfsldfdlsfdsaaaabbbb"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history