tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTableLineage

Last updated: 2024-06-21 15:10:39

1. API Description

Domain name for API request: wedata.tencentcloudapi.com.

List Table Lineage Information

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeTableLineage.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Direction Yes String Query Direction, INPUT, OUTPUT, BOTH enumerated values
Data Yes TableLineageInfo Table information
InputDepth No Integer Single Query Indegree, default 1
OutputDepth No Integer Single Query Outdegree, default 1
ExtParams.N No Array of LineageParamRecord Additional Parameters (Pass Caller Information)
IgnoreTemp No Boolean Filter Temporary Tables, default true
RecursiveSecond No Boolean Recursively Query Number of Secondary Nodes, default is true

3. Output Parameters

Parameter Name Type Description
TableLineage TableLineageInfo Table Lineage Information
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Table Lineage Information

Table Lineage Information

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableLineage
<Common request parameters>

{
    "Direction": "INPUT",
    "InputDepth": 1,
    "OutputDepth": 1,
    "Data": {
        "TableId": "nCG0n7zjR7-N-EbAAi8Ruw",
        "MetastoreType": "HIVE",
        "PrefixPath": ""
    },
    "IgnoreTemp": true
}

Output Example

{
    "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
        }
    }
}

Example2 List Table Lineage Information

List Table Lineage Information

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableLineage
<Common request parameters>

{
    "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
}

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM Signature/Authentication Error.
AuthFailure.SignatureExpire Not logged in or login has expired.
FailedOperation Operation Failure.
InvalidParameter Parameter error.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy