Register lineage for self-managed entities using RegisterLineageRelation - DataWorks - Alibaba Cloud - DataWorks

Operation description

This API operation is currently in trial. Users who want to try it out can submit an application. After the administrator adds the user to the trial list, the user can call this operation.

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
LineageRelationRegisterVO	LineageRelationRegisterVO	Yes	The structure whose lineage you want to register to DataWorks.

Entity unique identifier format: EntityType.EntityGuid

1: EntityType identifies the entity type
    1.1 Entity types available 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 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: EntityGuid: A unique identifier for the entity within the same entity type
    Users can define their own unique ID for custom entities

3: Entity examples:
    3.1: DataWorks built-in system entities, which can be viewed in the lineage graph on the Data Map page
        (1) maxcompute-table.project.tableName  represents the unique ID of a MaxCompute table
        (2) emr-table.kadfdfaccdd4ted   represents the unique ID of an EMR table
    3.2: Custom entities: Users define their own unique ID based on their business requirements (within 50 bytes)
        (1) custom-api.listUser   represents a custom API entity with the unique identifier listUser
        (2) custom-table.db1.table2  represents a custom table entity with the unique identifier db1.table2

Response elements

Element	Type	Description	Example
	object	OpenApiMetaResultModel
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The entity of lineage not exist, xxx
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	EE50E05E-028C-182B-****
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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.