全部产品
Search
文档中心

大数据开发治理平台 DataWorks:ListLineage - 查询实体血缘

更新时间:Nov 21, 2024

查询实体的上下游血缘关系。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*list
*全部资源
*

请求参数

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

实体唯一标识符。

maxcompute-table.project.table
NextTokenstring

分页信息,指定本次读取的起始点。

next-token-from-previous-request
Keywordstring

实体名称关键词。

name-keyword
Directionstring

血缘上下游。取值如下:

  • up:上游。
  • down:下游。
up
PageSizeinteger

分页大小,最大为 100。

10

返回参数

名称类型描述示例值
object

OpenApiMetaResultModel

HttpStatusCodeinteger

HTTP 状态码。

200
ErrorMessagestring

错误信息。

qualifiedName should be in format as entity-table.entity-guid
RequestIdstring

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

64B-587A-8CED-969E1973887FXXX-TT
Successboolean

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

  • true:调用成功。
  • false:调用失败。
true
ErrorCodestring

错误码。

1010040007
Dataobject

返回结构体。

NextTokenstring

分页信息,指定下次读取的起始点。

nextTokenFromRequest-xxxsd-ff
DataEntityListarray<object>

实体结构体数组。

DataEntityListobject

实体结构体。

EntityEntity

实体信息。

CreateTimestamplong

血缘创建时间。

1686215809269
RelationListarray<object>

关系结构体数组。

RelationListobject

关系结构体。

Guidstring

关系唯一 ID。

aaabbccddguid
Datasourcestring

数据源名称。

mysql
Typestring

任务类型:主要描述实体间关系类型。例如,通过 SQL 计算、通过报表字段映射、通过定义 API 等 。

sql
Channelstring

数据渠道:

  • FIRST_PARTY:DataWorks 平台数据。
  • THIRD_PARTY:用户注册的数据。
THIRD_PARTY

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "ErrorMessage": "qualifiedName should be in format as entity-table.entity-guid",
  "RequestId": "64B-587A-8CED-969E1973887FXXX-TT",
  "Success": true,
  "ErrorCode": "1010040007",
  "Data": {
    "NextToken": "nextTokenFromRequest-xxxsd-ff",
    "DataEntityList": [
      {
        "Entity": {
          "QualifiedName": "maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23",
          "TenantId": 12345,
          "EntityContent": {
            "test": "test",
            "test2": 1
          }
        },
        "CreateTimestamp": 1686215809269,
        "RelationList": [
          {
            "Guid": "aaabbccddguid",
            "Datasource": "mysql",
            "Type": "sql",
            "Channel": "THIRD_PARTY"
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史