查询数据地图给定两实体(表、字段、oss文件等)之间的血缘关系信息列表。
接口说明
- 需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
| PageNumber | integer | 否 | 分页页码,默认为 1。 | 1 |
| PageSize | integer | 否 | 分页大小,默认为 10,最大为 100。 | 10 |
返回参数
示例
正常返回示例
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
}
]
}
}错误码
访问错误中心查看更多错误码。
