数据开发治理平台 WeData 任务血缘上报接口

1. 接口描述

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

血缘上报接口

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ReportTaskLineage。
Version	是	String	公共参数，本接口取值：2021-08-20。
Region	是	String	公共参数，详见产品支持的地域列表。
ChannelType	是	String	上报渠道示例值：THIRD_REPORT
Task	是	LineageTask	血缘任务
ProjectId	否	String	项目ID 示例值：110111121
TableLineages.N	否	Array of TableLineagePair	表血缘关系
ColumnLineages.N	否	Array of ColumnLineagePair	列血缘关系

3. 输出参数

参数名称	类型	描述
RequestFromSource	String	请求来源，WEB 前端；CLIENT 客户端注意：此字段可能返回 null，表示取不到有效值。
Data	Boolean	上报结果示例值：true
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 上报测试用例

输入示例

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

{
    "ChannelType": "THIRD_REPORT",
    "Task": {
        "TaskId": "Task-001",
        "TaskType": "other",
        "TaskSource": "other",
        "ExtParams": [
            {
                "Key": "param1",
                "Value": "value1"
            },
            {
                "Key": "param2",
                "Value": "value2"
            }
        ]
    },
    "ProjectId": "1486804694126882816",
    "TableLineages": [
        {
            "Sources": [
                {
                    "DatasourceId": "61998",
                    "DatabaseName": "lineage_db1",
                    "TableName": "lineage_source_table1",
                    "CatalogName": "lineage_catalog1",
                    "TableType": "TABLE"
                },
                {
                    "DatasourceId": "61998",
                    "DatabaseName": "lineage_db2",
                    "TableName": "lineage_source_table2",
                    "CatalogName": "lineage_catalog1",
                    "TableType": "TABLE"
                },
                {
                    "DatasourceId": "61998",
                    "DatabaseName": "lineage_db2",
                    "TableName": "lineage_source_table3",
                    "CatalogName": "lineage_catalog1",
                    "TableType": "TABLE"
                }
            ],
            "Target": {
                "DatasourceId": "61998",
                "DatabaseName": "lineage_db3",
                "TableName": "lineage_target_table1",
                "CatalogName": "lineage_catalog1",
                "TableType": "TABLE"
            }
        },
        {
            "Sources": [
                {
                    "DatasourceId": "61999",
                    "DatabaseName": "lineage_db4",
                    "TableName": "lineage_source_table4",
                    "CatalogName": "lineage_catalog2",
                    "TableType": "TABLE"
                },
                {
                    "DatasourceId": "61999",
                    "DatabaseName": "lineage_db5",
                    "TableName": "lineage_source_table5",
                    "CatalogName": "lineage_catalog2",
                    "TableType": "TABLE"
                }
            ],
            "Target": {
                "DatasourceId": "61999",
                "DatabaseName": "lineage_db6",
                "TableName": "lineage_target_table2",
                "CatalogName": "lineage_catalog2",
                "TableType": "TABLE"
            }
        }
    ],
    "ColumnLineages": [
        {
            "Sources": [
                {
                    "DatasourceId": "61998",
                    "DatabaseName": "lineage_db1",
                    "TableName": "lineage_source_table1",
                    "CatalogName": "lineage_catalog1",
                    "TableType": "TABLE",
                    "ColumnName": "source_column1",
                    "ColumnType": "STRING"
                }
            ],
            "Target": {
                "DatasourceId": "61998",
                "DatabaseName": "lineage_db3",
                "TableName": "lineage_target_table1",
                "ColumnName": "target_column1",
                "CatalogName": "lineage_catalog1",
                "TableType": "TABLE",
                "ColumnType": "STRING"
            }
        }
    ]
}

输出示例

{
    "Response": {
        "Data": true,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameter	参数错误。

任务血缘上报接口

本页目录：