ListLineageRelationships - 查询数据地图血缘关系列表

查询数据地图给定两实体(表、字段、oss文件等)之间的血缘关系信息列表。

接口说明

  1. 需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

授权信息

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

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

请求参数

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

源实体 ID,可参考 ListTables / ListColumns 接口返回的表/字段 ID,以及自定义实体 ID

maxcompute-table:::project_name:[schema_name]:table_name
DstEntityIdstring

目标实体 ID,可参考 ListTables / ListColumns 接口返回的表/字段 ID,以及自定义实体 ID

dlf-table::catalog_id:database_name::table_name
SrcEntityNamestring

源实体名称,模糊匹配。

srcName
DstEntityNamestring

目标实体名称,模糊匹配。

dstName
SortBystring

排序字段,默认为 Name。

Name
Orderstring

排序方向,默认为 Asc,枚举值,当前支持:

  • Asc:升序
  • Desc:降序
Asc
PageNumberinteger

分页页码,默认为 1。

1
PageSizeinteger

分页大小,默认为 10,最大为 100。

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
Successboolean

请求是否成功。

true
PagingInfoobject

分页结果。

TotalCountlong

总数。

123
PageNumberinteger

页数,用于翻页。

1
PageSizeinteger

分页大小。

10
LineageRelationshipsarray

数据表列表。

LineageRelationshipsLineageRelationship

血缘关系结构体。

示例

正常返回示例

JSON格式

{
  "RequestId": "SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 123,
    "PageNumber": 1,
    "PageSize": 10,
    "LineageRelationships": [
      {
        "SrcEntity": {
          "Id": "maxcompute-table:::project_name:[schema_name]:table_name",
          "Name": "test_tbl",
          "Attributes": {
            "key": "value"
          }
        },
        "DstEntity": {
          "Id": "maxcompute-table:::project_name:[schema_name]:table_name",
          "Name": "test_tbl",
          "Attributes": {
            "key": "value"
          }
        },
        "Task": {
          "Id": 12345,
          "Type": "custom-sql",
          "Attributes": {
            "key": "value"
          }
        },
        "Id": "as78d756asd",
        "CreateTime": 1743040581000
      }
    ]
  }
}

错误码

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