调用RegisterLineageRelation将自有实体间的血缘关系注册到DataWorks平台上_大数据开发治理平台 DataWorks-阿里云帮助中心

本接口当前处于试用阶段。需要体验的用户可以提出申请，管理员加入试用名单后即可调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	RegisterLineageRelation	系统规定参数。取值：RegisterLineageRelation。
LineageRelationRegisterVO	LineageRelationRegisterVO	是		血缘注册结构体。

实体唯一标识格式：EntityType.EntityGuid

1：EntityType 标识实体类型
    1.1 Dataworks上已有的实体类型
        (1) maxcompute表：maxcompute-table
        (2) mysql表：mysql-table
        (3) emr表：emr-table 
        (4) holo表：holodb-table

    1.2 用户自定义的实体类型： custom-xxx
       根据用户需求，推荐使用如下类型
        (1) 表：custom-table
        (2) API：custom-api 
        (3) 应用：custom-app
        (4) 报表： custom-report
        (5) 数据集：custom-dataset
        (6) 数据源：custom-datasource

2: EntityGuid：在同一实体类型内部，唯一标识该实体的标识
    用户自定义的实体可以根据需要自己定义唯一ID

3: 实体举例：
    3.1：Dataworks已有系统实体，可以在数据地图页面血缘图中看到
        (1) maxcompute-table.project.tableName  表示maxcompute 表的唯一ID
        (2) emr-table.kadfdfaccdd4ted   表示emr表的唯一ID
    3.2：用自定义实体： 用户根据自己业务需求，自己定义出唯一Id，（50个字节以内）
        (1) custom-api.listUser   表示自定义api实体，其唯一标识为listUser 
        (2) custom-table.db1.table2  标识自定义表实体，其唯一标识为 db1.table2

返回数据

名称	类型	示例值	描述
HttpStatusCode	Integer	200	HTTP状态码。
ErrorMessage	String	The entity of lineage not exist, xxx	错误信息。
RequestId	String	EE50E05E-028C-182B-9xxx	请求的ID：用于定位日志、排查问题。
Success	Boolean	true	调用是否成功。取值如下： true：调用成功。 false：调用失败。
ErrorCode	String	1010210001	错误码。
LineageRelation	Object		血缘关系对象。
SrcEntityQualifiedName	String	maxcompute-table.project.table	源实体唯一标识。
DestEntityQualifiedName	String	custom-report.month_stat_user	目标实体唯一标识。
RelationshipGuid	String	dfsldfdlsfdsaaaabbbb	实体间血缘关系ID。

示例

请求示例

http(s)://[Endpoint]/?Action=RegisterLineageRelation
&LineageRelationRegisterVO={"SrcEntity":{"QualifiedName":"maxcompute-table.projectName.tablename","Name":"tableName","ParentName":"dbName","DetailUrl":"http://domain.test.url/entity"},"DestEntity":{"QualifiedName":"maxcompute-table.projectName.tablename","Name":"tableName","ParentName":"dbName","DetailUrl":"http://domain.test.url/entity"},"Relationship":{"Type":"sql"},"CreateTimestamp":1684327487964}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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"
  }
}

错误码

访问错误中心查看更多错误码。