更新时间:2025-09-15 GMT+08:00
分享

导入血缘(邀测)

功能介绍

血缘导入接口,一次性获取所有作业算子的血缘。该接口功能处于邀测阶段,后续将随功能公测将逐步开放。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

instance

String

实例ID,获取方法请参见实例ID和工作空间ID

表3 请求Body参数

参数

是否必选

参数类型

描述

input_source_id

String

上游血缘sourceId。

output_source_id

String

下游血缘sourceId。

lineage_configs

Array of SubNodeLineageConfig objects

血缘信息。

表4 SubNodeLineageConfig

参数

是否必选

参数类型

描述

name

String

节点名称。

sql_statement

String

备注血缘sql。

input_tables

Array of TableConfig objects

输入表。

output_table

TableConfig object

输出表。

column_lineages

Array of ColumnLineageConfig objects

字段血缘信息。

表5 TableConfig

参数

是否必选

参数类型

描述

database

String

数据库名称。

schema

String

schema名称。

table

String

表名称。

is_exist

Boolean

是否存在。

表6 ColumnLineageConfig

参数

是否必选

参数类型

描述

name

String

字段血缘节点名称。

input_columns

Array of ColumnConfig objects

输入字段血缘信息。

output_column

ColumnConfig object

输出字段血缘信息。

表7 ColumnConfig

参数

是否必选

参数类型

描述

database

String

数据库名称。

schema

String

schema名称。

table

String

表名称。

column

String

字段名称。

is_exist

Boolean

是否存在。

响应参数

状态码:200

表8 响应Body参数

参数

参数类型

描述

guids

Array of NodeLineageGuids objects

血缘信息资产guids。

表9 NodeLineageGuids

参数

参数类型

描述

node

String

节点guid。

column_lineages

Array of strings

schema名称。

状态码:400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

{
  "input_source_id" : "hive@d66e4a53-0929-4816-b41d-09b30f54d882",
  "output_source_id" : "hive@d66e4a53-0929-4816-b41d-09b30f54d882",
  "lineage_configs" : [ {
    "name" : "表级血缘1",
    "input_tables" : [ {
      "database" : "dls",
      "schema" : null,
      "table" : "test9999"
    } ],
    "output_table" : {
      "database" : "dls",
      "schema" : null,
      "table" : "aaa448"
    },
    "column_lineages" : [ {
      "name" : "字段血缘1",
      "input_columns" : [ {
        "database" : "dls",
        "schema" : null,
        "table" : "test9999",
        "column" : "ads"
      } ],
      "output_column" : {
        "database" : "dls",
        "schema" : null,
        "table" : "aaa448",
        "column" : "ft_col1"
      }
    } ]
  } ]
}

响应示例

状态码:200

OK。

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

SDK代码示例

SDK代码示例如下。

 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
48
49
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();
        ImportDataMapLineageRequestBody body = new ImportDataMapLineageRequestBody();
        request.withBody(body);
        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
32
33
# 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()
        request.body = ImportDataMapLineageRequestBody(
        )
        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
38
39
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{}
	request.Body = &model.ImportDataMapLineageRequestBody{
	}
	response, err := client.ImportDataMapLineage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK。

400

BadRequest。

401

Unauthorized。

403

Forbidden。

404

Not Found。

500

InternalServerError。

相关文档