Updated on 2025-07-28 GMT+08:00

Querying Data Lineages

Function

This API allows you to import raw datasets from OBS. You can use the OBS path to query all raw datasets created based on the path and the subsequent lineage information.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/data-management/lineages

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Used to obtain the permission required to call APIs. The token is the value of X-Subject-Token in the response header in Authentication.

Content-Type

Yes

String

MIME type of the request body. The value is application/json.

Table 2 Request query parameters

Parameter

Mandatory

Type

Description

limit

Yes

integer

Definition:

Maximum number of lineages can be returned by the API.

Constraints:

N/A

Value range:

[1, 1000]

Default value:

100

from_path

Yes

string

Definition:

Source OBS path.

Constraints:

Full OBS path of the end tenant.

Value range:

N/A

Default value:

N/A

Response Parameters

Parameter

Type

Description

lineages

array

Definition:

Dataset lineage list.

Constraints:

The type of items in the list is Lineage.

Value range:

N/A

Default value:

N/A

Example Request

GET https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/data-management/lineages?limit=100&from_path=bucket/folder1/folder2

Request Header:
Content_Type: application/json
X-Auth-Token: MIIVV...

Request Params:
limit: 1000
from_path: bucket/folder1/folder2

Example Response

{
    "lineages": [
        {
            "id": null,
            "from_id": null,
            "from_name": null,
            "from_catalog": null,
            "from_type": "OBS",
            "to_id": "1352299121133883392",
            "to_name": null,
            "to_catalog": "ORIGINAL",
            "to_type": "DATASET",
            "process_id": null,
            "process_name": null,
            "process_type": null,
            "train_job_name": null,
            "model_type": null,
            "train_type": null,
            "create_time": null,
            "from_path": "bucket/folder",
            "from_path_existed": null
        },
        {
            "id": "1352299380551585793",
            "from_id": "1352299121133883392",
"from_name": " time series-regression-test",
            "from_catalog": "ORIGINAL",
            "from_type": "DATASET",
            "to_id": "1352299379473649664",
"to_name": "pub_time series regression",
            "to_catalog": "PUBLISH",
            "to_type": "DATASET",
            "process_id": "lt_97a2aa4cca744775aa5c7cfe3cb36121",
"process_name": "pub_time series regression",
            "process_type": "PUBLISH",
            "train_job_name": null,
            "model_type": null,
            "train_type": null,
            "create_time": null,
            "from_path": null,
            "from_path_existed": null
        }
    ]
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.