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",
"InputDepth": 1,
"OutputDepth": 1,
"Data": {
"TableId": "nCG0n7zjR7-N-EbAAi8Ruw",
"MetastoreType": "HIVE",
"PrefixPath": ""
},
"IgnoreTemp": true
}输出示例
{
"Response": {
"RequestId": "cea6a2ea-a841-43ae-883a-805a58dc53d3",
"TableLineage": {
"ChildSet": "[]",
"CreateTime": "",
"DatasourceId": "",
"Description": "",
"DownStreamCount": 0,
"ExtParams": [],
"Id": null,
"MetastoreType": null,
"MetastoreTypeName": null,
"ModifyTime": "",
"Params": [],
"ParentSet": "[]",
"PrefixPath": "",
"ProjectId": null,
"QualifiedName": null,
"TableId": "nCG0n7zjR7-N-EbAAi8Ruw",
"TableName": "student",
"Tasks": [],
"UpStreamCount": 0
}
}
}示例2 列出表血缘信息
列出表血缘信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableLineage
<公共请求参数>
{
"Direction": "abc",
"InputDepth": 0,
"OutputDepth": 0,
"ExtParams": [
{
"Name": "abc",
"Value": "abc"
}
],
"Data": {
"ProjectId": "abc",
"DatasourceId": "abc",
"TableId": "abc",
"Params": [
{
"Name": "abc",
"Value": "abc"
}
],
"ParentSet": "abc",
"ChildSet": "abc",
"ExtParams": [
{
"Name": "abc",
"Value": "abc"
}
],
"Id": "abc",
"MetastoreType": "abc",
"MetastoreTypeName": "abc",
"TableName": "abc",
"QualifiedName": "abc",
"DownStreamCount": 0,
"UpStreamCount": 0,
"Description": "abc",
"PrefixPath": "abc",
"CreateTime": "abc",
"ModifyTime": "abc",
"Tasks": [
"abc"
]
},
"IgnoreTemp": true,
"RecursiveSecond": true
}输出示例
{
"Response": {
"TableLineage": {
"ProjectId": "abc",
"DatasourceId": "abc",
"TableId": "abc",
"Params": [
{
"Name": "abc",
"Value": "abc"
}
],
"ParentSet": "abc",
"ChildSet": "abc",
"ExtParams": [
{
"Name": "abc",
"Value": "abc"
}
],
"Id": "abc",
"MetastoreType": "abc",
"MetastoreTypeName": "abc",
"TableName": "abc",
"QualifiedName": "abc",
"DownStreamCount": 0,
"UpStreamCount": 0,
"Description": "abc",
"PrefixPath": "abc",
"CreateTime": "abc",
"ModifyTime": "abc",
"Tasks": [
"abc"
]
},
"RequestId": "abc"
}
}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 | 资源不存在。 |
