血缘查询
功能介绍
血缘查询。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/entities/{guid}/lineage
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
guid |
是 |
String |
资产guid,获取方法请参见数据资产guid。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
direction |
否 |
String |
查询方向,取值范围:BOTH、IN、OUT。默认BOTH。 |
depth |
否 |
Integer |
血缘链路长度,默认值5。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。 |
workspace |
是 |
String |
工作空间ID,获取方法请参见实例ID和工作空间ID。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
base_entity_guid |
String |
当前资产的guid。 |
guid_entity_map |
Object |
实体集合Map(String, OpenEntityHeader)。key:资产guid,value:资产信息OpenEntityHeader。 |
relations |
Array of LineageRelation objects |
血缘关系。 |
referred_entities |
Object |
相关实体集合Map(String, OpenEntity)。key:资产guid,value:资产信息OpenEntity。 |
参数 |
参数类型 |
描述 |
---|---|---|
from_entity_id |
String |
血缘来源资产guid。 |
relationship_id |
String |
关系id。 |
to_entity_id |
String |
血缘流向资产guid。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
无
响应示例
状态码: 200
OK。
{ "base_entity_guid" : "c1cba918-24d3-4dc4-a65c-178e57b14458", "guid_entity_map" : { "c1cba918-24d3-4dc4-a65c-178e57b14458" : { "attributes" : { "owner" : "userName", "create_time" : 0, "qualified_name" : "MRS_Flink_Job_001.flink_01@FLINK.f9a70740-6a5e-492a-a369-9779fd952f85.0833a5737480d53b2f25c010dc1a7b88-workspace -b88c445407b24283aa949f9833a38fd8", "name" : "flink_01", "description" : "This temp entity was generated from DLF lineage service", "security_level" : null }, "classification_names" : [ ], "connection" : null, "display_text" : "flink_01", "guid" : "c1cba918-24d3-4dc4-a65c-178e57b14458", "tags" : [ ], "type_name" : "flink_table" }, "223d0579-cf6f-4439-950b-7372a0f1a5a2" : { "attributes" : { "owner" : "userName", "create_time" : 0, "qualified_name" : "MRS_Flink_Job_001.flink_02@FLINK.f9a70740-6a5e-492a-a369-9779fd952f85.0833a5737480d53b2f25c010dc1a7b88-workspace -b88c445407b24283aa949f9833a38fd8", "name" : "flink_02", "description" : "This temp entity was generated from DLF lineage service", "security_level" : null }, "classification_names" : [ ], "connection" : null, "display_text" : "flink_02", "guid" : "223d0579-cf6f-4439-950b-7372a0f1a5a2", "tags" : [ ], "type_name" : "flink_table" }, "e2f63e6a-206d-4090-a032-7e038d507269" : { "attributes" : { "owner" : "userName", "outputs" : [ { "uniqueAttributes" : { "qualifiedName" : "MRS_Flink_Job_001.flink_01@FLINK.f9a70740-6a5e-492a-a369-9779fd952f85.0833a5737480d53b2f25c010dc1a7b88-workspace -b88c445407b24283aa949f9833a38fd8" }, "typeName" : "flink_table", "name" : "flink_01", "guid" : "c1cba918-24d3-4dc4-a65c-178e57b14458" } ], "create_time" : null, "qualified_name" : "509207.42419233-b3f5-42b3-a314-336132c23328@dlf_job.0833a5737480d53b2f25c010dc1a7b88-workspace -1b59d3c777ad4d619b89eeac4f3cce87", "inputs" : [ { "uniqueAttributes" : { "qualifiedName" : "MRS_Flink_Job_001.flink_02@FLINK.f9a70740-6a5e-492a-a369-9779fd952f85.0833a5737480d53b2f25c010dc1a7b88-workspace -b88c445407b24283aa949f9833a38fd8" }, "typeName" : "flink_table", "name" : "flink_02", "guid" : "223d0579-cf6f-4439-950b-7372a0f1a5a2" } ], "name" : "MRS_Flink_Job_001", "description" : "Workspace: kw_test", "security_level" : "l1" }, "classification_names" : [ ], "connection" : null, "display_text" : "MRS_Flink_Job_001", "guid" : "e2f63e6a-206d-4090-a032-7e038d507269", "tags" : [ ], "type_name" : "flink_node" } }, "referred_entities" : { }, "relations" : [ { "from_entity_id" : "e2f63e6a-206d-4090-a032-7e038d507269", "relationship_id" : "b5ec94b0-e779-49a8-adef-f6bbf46bf63c", "to_entity_id" : "c1cba918-24d3-4dc4-a65c-178e57b14458" }, { "from_entity_id" : "223d0579-cf6f-4439-950b-7372a0f1a5a2", "relationship_id" : "7a1b8777-3bd9-460a-b729-70d3d3bf3744", "to_entity_id" : "e2f63e6a-206d-4090-a032-7e038d507269" } ] }
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 |
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 ShowLineageSolution { 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(); ShowLineageRequest request = new ShowLineageRequest(); request.withGuid("{guid}"); try { ShowLineageResponse response = client.showLineage(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 |
# 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 = ShowLineageRequest() request.guid = "{guid}" response = client.show_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 |
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.ShowLineageRequest{} request.Guid = "{guid}" response, err := client.ShowLineage(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。 |