Obtains the lineage information of a deployment.
Try it now
Test
RAM authorization
Request syntax
POST /meta/v2/lineage HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspace |
string |
Yes |
The workspace ID. |
710d6a64d8**** |
| body | GetLineageInfoParams |
No |
The parameters about the lineage information. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
If the value of success was true, the lineage information of a deployment in a namespace was returned. If the value of success was false, a null value was returned. |
||
| requestId |
string |
The request ID. |
CBC799F0-AS7S-1D30-8A4F-882ED4DD**** |
| success |
boolean |
Indicates whether the request was successful. |
true |
| httpCode |
integer |
The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful. |
200 |
| errorCode |
string |
|
"" |
| errorMessage |
string |
|
"" |
| data | LineageInfo |
The lineage information. |
Examples
Success response
JSON format
{
"requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
"success": true,
"httpCode": 200,
"errorCode": "\"\"",
"errorMessage": "\"\"",
"data": {
"nodes": [
{
"id": "97383",
"catalogName": "paimon",
"databaseName": "paimon-ods",
"isTemporary": false,
"connector": "paimon",
"tables": [
{
"id": "434508",
"tableName": "order-test",
"with": {
"test": "test",
"test2": 1
},
"properties": {
"test": "test",
"test2": 1
},
"columns": [
{
"id": "123ss3",
"columnName": "name",
"nullable": false,
"description": "Order username",
"columnType": "string",
"columnNativeType": "string",
"createdAt": 1723537978,
"modifiedAt": 1723537978,
"creator": "userA",
"modifier": "userA"
}
]
}
]
}
],
"edges": {
"tableLineage": [
{
"source": "TableA",
"destination": "TableB",
"jobId": "664cc64d-5dea-4ad3-9ee4-8432a874****"
}
],
"columnLineage": [
{
"source": "TableA",
"destination": "TableB",
"jobId": "664cc64d-5dea-4ad3-9ee4-8432a874****"
}
]
},
"jobInfos": [
{
"id": "664cc64d-5dea-4ad3-9ee4-8432a874****\n",
"properties": {
"test": "test",
"test2": 1
}
}
]
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.