Lineage query
Function
Lineage query.
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 /v3/{project_id}/entities/{guid}/lineage
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain it, see Project ID and Account ID. |
| guid | Yes | String | Asset GUID. For details about how to obtain the asset GUID, see Data Asset GUID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| direction | No | String | Query direction. The value can be BOTH, IN, or OUT. The default value is BOTH. |
| depth | No | Integer | Lineage link length. The default value is 5. |
Request 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. |
| workspace | Yes | String | Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| base_entity_guid | String | GUID of the current asset. |
| guid_entity_map | Object | Entity set, which is Map (String, OpenEntityHeader). The key is the asset GUID, and value is the asset information OpenEntityHeader. |
| relations | Array of LineageRelation objects | Lineage. |
| referred_entities | Object | Related entity set, which is Map(String, OpenEntity). The key is the asset GUID, and value is the asset information OpenEntity. |
| Parameter | Type | Description |
|---|---|---|
| from_entity_id | String | Lineage source asset GUID. |
| relationship_id | String | Relationship ID. |
| to_entity_id | String | Lineage flows to the asset guid. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
None
Example Responses
Status code: 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 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 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) } } |
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. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot