Updated on 2026-07-02 GMT+08:00

Batch Lineage (Invitational Test)

Function

This API is used to obtain the lineages of all job nodes. It is in invitational test and will be available for OBT in the future.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/datamap/lineage/bulk

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset of the pagination parameter. The default value is 0.

limit

No

Integer

Number of records on each page. The default value is 100.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

instance

Yes

String

Instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Number

Number of job operators. During batch query, the lineage is obtained based on job operators.

data

Array of TableLineageInfo objects

Table lineage list of job operators on the current page

Table 5 TableLineageInfo

Parameter

Type

Description

source_guid

String

GUID of the upstream lineage asset.

source_qualified_name

String

Qname of the upstream lineage asset

source_type

String

Type of the upstream lineage asset

source_db

String

Upstream lineage asset database.

source_schema

String

Upstream lineage asset logic library.

source_table

String

Upstream lineage asset table.

target_guid

String

Indicates the GUID of the downstream lineage asset.

target_qualified_name

String

Qname of the downstream lineage asset.

target_type

String

Downstream lineage asset type.

target_db

String

Downstream lineage asset database.

target_schema

String

Downstream lineage asset logic library.

target_table

String

Downstream lineage asset table.

node_guid

String

GUID of the job operator.

node_name

String

Name of a job operator.

node_type

String

Job operator type.

node_qualified_name

String

Qname of the job operator.

workspace_id

String

Space to which the job operator type belongs.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK.

{
  "total" : 2,
  "data" : [ {
    "source_guid" : "da431e05-804a-491f-945a-a29cfb77e635",
    "source_qualified_name" : "wk.dli_01@dli.0833a5737480d53b2f25c010dc1a7b88-workspace-b88c445407b24283aa949f9833a38fd8",
    "source_type" : "dli_table_managed",
    "source_db" : "wk",
    "source_schema" : null,
    "source_table" : "dli_01",
    "target_guid" : "f74609f6-8a65-492b-991c-ae39918c69ad",
    "target_qualified_name" : "wk.dli_02@dli.0833a5737480d53b2f25c010dc1a7b88-workspace-b88c445407b24283aa949f9833a38fd8",
    "target_type" : "dli_table_managed",
    "target_db" : "wk",
    "target_schema" : null,
    "target_table" : "dli_02",
    "node_guid" : "460abeae-aad4-4456-8c35-5ec530506ae2",
    "node_name" : "DLI_SQL_6038",
    "node_type" : "dli_sql_node",
    "node_qualified_name" : "19431260.32e27312-223e-4333-a231-333122123124@dlf_job.0833a5737480d53b2f25c010dc1a7b88-workspace-b88c445407b24283aa949f9833a38fd8",
    "workspace_id" : "b88c445407b24283aa949f9833a38fd8"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class ShowLineageBulkSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DataArtsStudioClient client = DataArtsStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowLineageBulkRequest request = new ShowLineageBulkRequest();
        try {
            ShowLineageBulkResponse response = client.showLineageBulk(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DataArtsStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowLineageBulkRequest()
        response = client.show_lineage_bulk(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewDataArtsStudioClient(
        dataartsstudio.DataArtsStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowLineageBulkRequest{}
	response, err := client.ShowLineageBulk(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK.

400

Bad request.

401

Unauthorized:

403

Forbidden.

404

Not found.

500

Internal server error.