Batch Lineage (Invitational Test)

Function

This API is used to obtain the lineages of all job nodes. It is in invitational test and will be available for OBT in the future.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/datamap/lineage/bulk

**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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset of the pagination parameter. The default value is 0.
limit	No	Integer	Number of records on each page. The default value is 100.

Request Parameters

**Table 3** 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 the instance ID, see Instance ID and Workspace ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Number	Number of job operators. During batch query, the lineage is obtained based on job operators.
data	Array of TableLineageInfo objects	Table lineage list of job operators on the current page

**Table 5** TableLineageInfo
Parameter	Type	Description
source_guid	String	GUID of the upstream lineage asset.
source_qualified_name	String	Qname of the upstream lineage asset
source_type	String	Type of the upstream lineage asset
source_db	String	Upstream lineage asset database.
source_schema	String	Upstream lineage asset logic library.
source_table	String	Upstream lineage asset table.
target_guid	String	Indicates the GUID of the downstream lineage asset.
target_qualified_name	String	Qname of the downstream lineage asset.
target_type	String	Downstream lineage asset type.
target_db	String	Downstream lineage asset database.
target_schema	String	Downstream lineage asset logic library.
target_table	String	Downstream lineage asset table.
node_guid	String	GUID of the job operator.
node_name	String	Name of a job operator.
node_type	String	Job operator type.
node_qualified_name	String	Qname of the job operator.
workspace_id	String	Space to which the job operator type belongs.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

None

Example Responses

Status code: 200

OK.

{
  "total" : 2,
  "data" : [ {
    "source_guid" : "da431e05-804a-491f-945a-a29cfb77e635",
    "source_qualified_name" : "wk.dli_01@dli.0833a5737480d53b2f25c010dc1a7b88-workspace-b88c445407b24283aa949f9833a38fd8",
    "source_type" : "dli_table_managed",
    "source_db" : "wk",
    "source_schema" : null,
    "source_table" : "dli_01",
    "target_guid" : "f74609f6-8a65-492b-991c-ae39918c69ad",
    "target_qualified_name" : "wk.dli_02@dli.0833a5737480d53b2f25c010dc1a7b88-workspace-b88c445407b24283aa949f9833a38fd8",
    "target_type" : "dli_table_managed",
    "target_db" : "wk",
    "target_schema" : null,
    "target_table" : "dli_02",
    "node_guid" : "460abeae-aad4-4456-8c35-5ec530506ae2",
    "node_name" : "DLI_SQL_6038",
    "node_type" : "dli_sql_node",
    "node_qualified_name" : "19431260.32e27312-223e-4333-a231-333122123124@dlf_job.0833a5737480d53b2f25c010dc1a7b88-workspace-b88c445407b24283aa949f9833a38fd8",
    "workspace_id" : "b88c445407b24283aa949f9833a38fd8"
  } ]
}