更新时间:2024-11-06 GMT+08:00
分享

创建血缘信息

功能介绍

创建血缘信息

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/lineage/lineage-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

workspace

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

cluster_id

String

集群id

data_source_type

String

数据连接类型

connection_id

String

数据连接id

connection_name

String

数据连接名称

workspace_id

String

工作空间id

job_id

String

作业id

node_name

String

算子名称

table_lineage

TableLineageV2 object

血缘对象

表4 TableLineageV2

参数

是否必选

参数类型

描述

input_tables

Array of TableInfoV2 objects

上游血缘表列表,列表大小:1至100

output_tables

Array of TableInfoV2 objects

下游血缘表列表,列表大小:1至100

column_lineages

Array of ColumnLineageV2 objects

字段血缘列表,列表大小:0至100

表5 TableInfoV2

参数

是否必选

参数类型

描述

catalog

String

目录名称

database

String

数据库名称

schema

String

逻辑库名称

table

String

表名称

表6 ColumnLineageV2

参数

是否必选

参数类型

描述

input_columns

Array of ColumnDetails objects

上游血缘字段列表,列表大小:1至100

output_columns

Array of ColumnDetails objects

下游血缘字段列表,列表大小:1至100

表7 ColumnDetails

参数

是否必选

参数类型

描述

database

String

数据库名称。

schema

String

逻辑库名称。

table

String

表名称。

column

String

字段名称。

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ObjectIdInfo objects

血缘导入结果

表9 ObjectIdInfo

参数

参数类型

描述

name

String

作业算子名称。

type_name

String

资产类型。

qualified_name

String

作业资产唯一限定名称。

状态码: 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

错误描述。

请求示例

{
  "cluster_id" : "actual_cluster_id",
  "data_source_type" : "actual_data_source_type",
  "connection_id" : "003b3ed52daf41e6829a0bc74526f5f7",
  "connection_name" : "dli_test",
  "workspace_id" : "1b59d3c777ad4d619b89eeac4f3cce87",
  "job_id" : "testJobID",
  "node_name" : "testNodeMName",
  "table_lineage" : {
    "input_tables" : [ {
      "catalog" : "spark_catalog",
      "database" : "nbbtemp",
      "schema" : "",
      "table" : "origndata_typeall"
    } ],
    "output_tables" : [ {
      "catalog" : "spark_catalog",
      "database" : "nbbtemp",
      "schema" : "",
      "table" : "lineageTable1"
    } ],
    "column_lineages" : [ {
      "input_columns" : [ {
        "database" : "nbbtemp",
        "schema" : "",
        "table" : "origndata_typeall",
        "column" : "stringf"
      } ],
      "output_columns" : [ {
        "database" : "nbbtemp",
        "schema" : "",
        "table" : "lineageTable1",
        "column" : "col1"
      } ]
    } ]
  }
}

响应示例

状态码: 200

OK

[ {
  "name" : "test",
  "type_name" : "Node",
  "qualified_name" : "manual.a0683065-cfb6-42d3-a0ff-87b2cc5e3c79@node.0833a5737480d53b2f25c010dc1a7b88-workspace-ee119e8faee347a389e8c295b926331c"
} ]

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

    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();
        CreateLineageInfoRequest request = new CreateLineageInfoRequest();
        LineageInfoRequest body = new LineageInfoRequest();
        request.withBody(body);
        try {
            CreateLineageInfoResponse response = client.createLineageInfo(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 = CreateLineageInfoRequest()
        request.body = LineageInfoRequest(
        )
        response = client.create_lineage_info(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.CreateLineageInfoRequest{}
	request.Body = &model.LineageInfoRequest{
	}
	response, err := client.CreateLineageInfo(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

相关文档