文档

RegisterLineageRelation - 注册血缘关系

更新时间:

注册实体关系,支持用户注册自定义的实体关系。

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
LineageRelationRegisterVOLineageRelationRegisterVO

血缘注册结构体。

实体唯一标识格式: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

返回参数

名称类型描述示例值
object

OpenApiMetaResultModel

HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

The entity of lineage not exist, xxx
RequestIdstring

请求的 ID:用于定位日志、排查问题。

EE50E05E-028C-182B-9xxx
Successboolean

调用是否成功。取值如下:

  • true:调用成功。

  • false:调用失败。

true
ErrorCodestring

错误码。

1010210001
LineageRelationobject

血缘关系对象。

SrcEntityQualifiedNamestring

源实体唯一标识。

maxcompute-table.project.table
DestEntityQualifiedNamestring

目标实体唯一标识。

custom-report.month_stat_user
RelationshipGuidstring

实体间血缘关系 ID。

dfsldfdlsfdsaaaabbbb

示例

正常返回示例

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)