1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
列出表血缘信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTableLineage。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Direction | 是 | String | 查询方向枚举值 - INPUT - OUTPUT - BOTH 示例值：BOTH |
| Data | 是 | TableLineageInfo | 表信息 |
| InputDepth | 否 | Integer | 单次查询入度,默认 1 示例值：1 |
| OutputDepth | 否 | Integer | 单次查询出度,默认 1 示例值：1 |
| ExtParams.N | 否 | Array of LineageParamRecord | 额外参数（传递调用方信息） |
| IgnoreTemp | 否 | Boolean | 是否过滤临时表,默认true 示例值：true |
| RecursiveSecond | 否 | Boolean | 是否递归查询二级节点数目，默认为true 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TableLineage | TableLineageInfo | 表血缘信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 表血缘信息
表血缘信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableLineage
<公共请求参数>
{
"Direction": "INPUT",
"Data": {
"MetastoreType": "HIVE",
"PrefixPath": "",
"TableId": "JqDviGd3SJKP1DzlUbbccdd"
},
"IgnoreTemp": true,
"InputDepth": 1,
"OutputDepth": 1
}输出示例
{
"Response": {
"RequestId": "e269b107-113c-4e21-a268-75da4abbf9a4",
"TableLineage": {
"ChannelType": null,
"ChildSet": null,
"CreateTime": "",
"DatabaseId": "1-zla91ZRLOUNMC9aabbcc",
"DatabaseName": "box",
"DatasourceId": "9323",
"DatasourceName": "hive_emr-cvdaabbcc",
"Description": "",
"DisplayType": null,
"DownStreamCount": 0,
"ExtParams": [],
"Id": null,
"MetastoreType": null,
"MetastoreTypeName": null,
"ModifyTime": "",
"Params": [],
"ParentSet": null,
"PrefixPath": "",
"ProjectId": null,
"QualifiedName": null,
"TableId": "JqDviGd3SJKP1DzlUXaabbcc",
"TableName": "0210_biao1",
"TableType": null,
"Tasks": [],
"UpStreamCount": 0
}
}
}示例2 表血缘信息2
表血缘信息2
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableLineage
<公共请求参数>
{
"Direction": "OUTPUT",
"InputDepth": 1,
"OutputDepth": 1,
"Data": {
"MetastoreType": "HIVE",
"PrefixPath": "",
"TableId": "Qvkit5nqSYqTmn3IAQrpYQ"
},
"IgnoreTemp": true
}输出示例
{
"Response": {
"RequestId": "ca391b2a-be9d-4412-a699-98ecd6479a06",
"TableLineage": {
"ChannelType": null,
"ChildSet": "[{\"ProjectId\":\"180589\",\"Params\":[],\"Id\":\"5be96928b52c8db567cbe90d7bac1e10\",\"MetastoreType\":\"HIVE\",\"MetastoreTypeName\":\"HIVE\",\"TableType\":\"TABLE\",\"TableName\":\"student_table_copy\",\"Guid\":\"u_bLpJpLQ06sUMCkZNhSyQ\",\"QualifiedName\":\"guldan_ods.student_table_copy\",\"DownStreamCount\":1,\"UpStreamCount\":1,\"Description\":\"\",\"PrefixPath\":\"f208bc03544797d08ef9d9eca39bdafb@5be96928b52c8db567cbe90d7bac1e10\",\"CreateTime\":\"2023-09-14 23:22:40\",\"ModifyTime\":\"2024-03-06 19:40:40\",\"Tasks\":[\"6202404301808319831\",\"6202404301730219946\",\"6202309150003168701\",\"6202311061201443094\",\"20230824011039676\",\"6202408030252238415\",\"6202404301807395098\"],\"SyncTasks\":\"[]\",\"ParentSet\":[],\"ChildSet\":[],\"ExtParams\":[{\"Name\":\"flag\",\"Value\":\"false\"},{\"Name\":\"nodeid\",\"Value\":\"fef4da76-c810-4fa7-b26b-b257c4c322dd\"}],\"DatasourceId\":\"43392\"}]",
"CreateTime": "2023-09-14 23:22:40",
"DatabaseId": "a2x29pNmQbysZRaTCoZaUA",
"DatabaseName": "guldan_ods",
"DatasourceId": "43392",
"DatasourceName": "hive_emr-foxwi67c",
"Description": "",
"DisplayType": null,
"DownStreamCount": 1,
"EngineType": null,
"ExtParams": [
{
"Name": "flag",
"Value": "true"
},
{
"Name": "nodeid",
"Value": "dfde51fb-dd33-48a3-ab26-22ea610ba7b3"
}
],
"Id": "f208bc03544797d08ef9d9eca39bdafb",
"MetastoreType": "HIVE",
"MetastoreTypeName": "HIVE",
"ModifyTime": "2024-03-06 19:40:40",
"Params": [],
"ParentSet": "",
"PrefixPath": "f208bc03544797d08ef9d9eca39bdafb",
"ProjectId": "180589",
"QualifiedName": "guldan_ods.student_table",
"TableId": "Qvkit5nqSYqTmn3IAQrpYQ",
"TableName": "student_table",
"TableType": "TABLE",
"Tasks": [
"6202404301808319831",
"6202404301730219946",
"6202309150003168701",
"6202311061201443094",
"20230824011039676",
"6202408030252238415",
"6202404301807395098"
],
"UpStreamCount": 0
}
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.SignatureExpire | 未登录或登录已过期。 |
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |
