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

更新时间:
复制为 MD 格式

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

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:ListLineageRelationships

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

SrcEntityId

string

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

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

DstEntityId

string

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

dlf-table::catalog_id:database_name::table_name

SrcEntityName

string

源实体名称,模糊匹配。

srcName

DstEntityName

string

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

dstName

SortBy

string

排序字段,默认为 Name。

Name

Order

string

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

  • Asc:升序

  • Desc:降序

Asc

PageNumber

integer

分页页码,默认为 1。

1

PageSize

integer

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

10

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

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

SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF

Success

boolean

请求是否成功。

true

PagingInfo

object

分页结果。

TotalCount

integer

总数。

123

PageNumber

integer

页数,用于翻页。

1

PageSize

integer

分页大小。

10

LineageRelationships

array

数据表列表。

LineageRelationship

血缘关系结构体。

示例

正常返回示例

JSON格式

{
  "RequestId": "SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 123,
    "PageNumber": 1,
    "PageSize": 10,
    "LineageRelationships": [
      {
        "SrcEntity": {
          "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "DstEntity": {
          "Id": "maxcompute-table:123456XXX::test_project::test_tbl\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\nhms-table:c-abc123xxx::test_db::test_tbl\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\ncustom-api:api123\ncustom-table:table456",
          "Name": "test_tbl",
          "Attributes": {
            "key": "key1:value1"
          }
        },
        "Task": {
          "Id": "12345",
          "Type": "custom-sql",
          "Attributes": {
            "key": "key1:value21"
          }
        },
        "Id": "maxcompute-table.p.table:custom-table.xxx:custom-sql.123",
        "CreateTime": 1743040581000
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情