Help Center/ DataArts Studio/ API Reference/ DataArts Catalog APIs/ Data Map APIs/ Importing a Lineage (Closed Beta Test)
Updated on 2026-07-02 GMT+08:00

Importing a Lineage (Closed Beta Test)

Function

This API is used to import a lineage. It is in closed beta 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

POST /v1/{project_id}/datamap/lineage/import

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.

Request Parameters

Table 2 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 it, see Instance ID and Workspace ID.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

input_source_id

Yes

String

Upstream lineage source ID.

output_source_id

Yes

String

Downstream lineage source ID.

lineage_configs

Yes

Array of SubNodeLineageConfig objects

Lineage information.

Table 4 SubNodeLineageConfig

Parameter

Mandatory

Type

Description

name

Yes

String

Node name.

sql_statement

No

String

Remarks lineage SQL statement.

input_tables

Yes

Array of TableConfig objects

Input table.

output_table

Yes

TableConfig object

Output table.

column_lineages

No

Array of ColumnLineageConfig objects

Field lineage information.

Table 5 TableConfig

Parameter

Mandatory

Type

Description

database

No

String

Database name.

schema

No

String

Schema name.

table

No

String

Table name.

is_exist

No

Boolean

Exist or not

Table 6 ColumnLineageConfig

Parameter

Mandatory

Type

Description

name

No

String

Field lineage node name.

input_columns

Yes

Array of ColumnConfig objects

Lineage information of the input field.

output_column

Yes

ColumnConfig object

Output field lineage information.

Table 7 ColumnConfig

Parameter

Mandatory

Type

Description

database

Yes

String

Database name.

schema

No

String

Schema name.

table

Yes

String

Table name.

column

Yes

String

Field name

is_exist

No

Boolean

Exist or not

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

guids

Array of NodeLineageGuids objects

Lineage information asset GUIDs.

Table 9 NodeLineageGuids

Parameter

Type

Description

node

String

Node GUID.

column_lineages

Array of strings

Schema name.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

{
  "input_source_id" : "hive@d66e4a53-0929-4816-b41d-09b30f54d882",
  "output_source_id" : "hive@d66e4a53-0929-4816-b41d-09b30f54d882",
  "lineage_configs" : [ {
    "name" : "Table-level lineage 1",
    "input_tables" : [ {
      "database" : "dls",
      "schema" : null,
      "table" : "test9999"
    } ],
    "output_table" : {
      "database" : "dls",
      "schema" : null,
      "table" : "aaa448"
    },
    "column_lineages" : [ {
      "name" : "Field lineage 1",
      "input_columns" : [ {
        "database" : "dls",
        "schema" : null,
        "table" : "test9999",
        "column" : "ads"
      } ],
      "output_column" : {
        "database" : "dls",
        "schema" : null,
        "table" : "aaa448",
        "column" : "ft_col1"
      }
    } ]
  } ]
}

Example Responses

Status code: 200

OK.

{
  "guids" : [ {
    "node" : "285cde264c25d20e030e5f7822097c22",
    "column_lineages" : [ "dd10a433e2199f8fc5f38285394c3ac4" ]
  } ]
}

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 ImportDataMapLineageSolution {

    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();
        ImportDataMapLineageRequest request = new ImportDataMapLineageRequest();
        try {
            ImportDataMapLineageResponse response = client.importDataMapLineage(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 = ImportDataMapLineageRequest()
        response = client.import_data_map_lineage(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.ImportDataMapLineageRequest{}
	response, err := client.ImportDataMapLineage(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

InternalServerError.