数据开发治理平台 WeData
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据开发治理平台 WeData > API 文档 > 元数据相关接口 > 列出字段血缘信息

列出字段血缘信息

最近更新时间：2024-03-12 02:06:25

我的收藏

本页目录：

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

列出字段血缘信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeColumnLineage。
Version 是 String 公共参数，本接口取值：2021-08-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
Direction 是 String 查询方向，INPUT,OUTPUT,BOTH枚举值
示例值：BOTH
Data 是 ColumnLineageInfo 字段信息
InputDepth 否 Integer 单次查询入度
示例值：1
OutputDepth 否 Integer 单次查询出度
示例值：1
ExtParams.N 否 Array of RecordField 额外参数（传递调用方信息）
IgnoreTemp 否 Boolean 是否过滤临时表 默认值为true

3. 输出参数

参数名称 类型 描述
ColumnAggregationLineage ColumnAggregationLineage 字段血缘信息
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 列出表血缘信息

列出表血缘信息

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeColumnLineage
<公共请求参数>

{
    "Direction": "xx",
    "InputDepth": 0,
    "ExtParams": [
        {
            "Name": "xx",
            "Value": "xx"
        }
    ],
    "OutputDepth": 0,
    "IgnoreTemp": true,
    "Data": {
        "ParentId": "xx",
        "Params": "xx",
        "MetastoreType": "xx",
        "RelationParams": "xx",
        "QualifiedName": "xx",
        "Description": "xx",
        "TableName": "xx",
        "ColumnNameCn": "xx",
        "ParentSet": "xx",
        "ChildSet": "xx",
        "ColumnType": "xx",
        "UpStreamCount": 0,
        "PrefixPath": "xx",
        "DatasourceId": "xx",
        "ModifyTime": "xx",
        "MetastoreTypeName": "xx",
        "Tasks": [
            "xx"
        ],
        "DownStreamCount": 0,
        "ExtParams": [
            {
                "Name": "xx",
                "Value": "xx"
            }
        ],
        "Id": "xx",
        "ColumnName": "xx",
        "TableId": "xx",
        "CreateTime": "xx"
    }
}

输出示例

{
    "Response": {
        "RequestId": "xx",
        "ColumnAggregationLineage": {
            "ChildSet": "xx",
            "ParentSet": "xx",
            "ParentId": "xx",
            "TableName": "xx",
            "MetastoreType": "xx",
            "ColumnInfoSet": [
                {
                    "QualifiedName": "xx",
                    "Tasks": [
                        "xx"
                    ],
                    "ColumnType": "xx",
                    "Description": "xx",
                    "DownStreamCount": 0,
                    "UpStreamCount": 0,
                    "CreateTime": "xx",
                    "ColumnName": "xx",
                    "PrefixPath": "xx",
                    "Params": "xx",
                    "ModifyTime": "xx",
                    "RelationParams": "xx",
                    "ColumnNameCn": "xx",
                    "Id": "xx",
                    "DatasourceId": "xx"
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.SignatureExpire 未登录或登录已过期。
FailedOperation 操作失败。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。
中国站