View processing result lineage¶
Read the complete processing link of a workflow product, including source files, workflow calls and processing topology.
HTTP
GET $CLOUDSIGMA_API_BASE/lineage/artifacts/{artifact_id}/overview
Before you call this API¶
Configure the regional API endpoint and authentication, and select the target workspace.
First query the file processing link and obtain the product ID from the corresponding data.artifact.artifact_id.
Request¶
Shell
curl "$CLOUDSIGMA_API_BASE/lineage/artifacts/$ARTIFACT_ID/overview" \
-H "X-API-Key: $CLOUDSIGMA_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
artifact_id | string | Required | Processing result ID, taken from data.artifact.artifact_id in file processing lineage. |
Successful response¶
data returns artifacts, workflow calls, and processing topology. The topology contains associated nodes, which does not mean that each node directly processes the product.
The response fields are as follows.
In field paths, [] denotes each item in an array. For example, items[].name is the name field of each item in the items array.
JSON
{
"code": "OK",
"msg": "OK",
"data": {
"artifact": {
"artifact_id": "art-001",
"root_asset_id": "asset-001",
"case_id": "case-001",
"parsed_file_available": true
},
"workflow": {
"workflow_id": "wf-001",
"workflow_version_id": "ver-001"
},
"workflow_invocation": {
"input": {},
"vars": {}
},
"topology": {
"nodes": [
{
"node_id": "node-001",
"label": "解析文件",
"status": "success"
}
],
"edges": [],
"producer_node_id": "node-001"
},
"entry": {}
}
}
| Field | Type | Description |
|---|---|---|
code | string | OK when successful. |
msg | string | OK when successful. |
data.artifact.artifact_id | string | Product ID. |
data.artifact.root_asset_id | string | Root data asset ID. |
data.artifact.case_id | string | Association case ID. |
data.artifact.parsed_file_available | boolean | Whether the parsed file is available. |
data.workflow.workflow_id | string | Workflow ID; returned only if there is a value. |
data.workflow.workflow_version_id | string | Workflow version ID; returned only if there is a value. |
data.workflow_invocation.input | object | Workflow call input; only returned if there is a value. |
data.workflow_invocation.vars | object | Workflow call variables; only returned if there is a value. |
data.topology.nodes[] | array | Processing node, the node can contain node_id, label, status, duration_ms and error. |
data.topology.edges[] | array | Topological edge, including source_node_id and target_node_id. |
data.topology.producer_node_id | string | ID of the node that produced the current product; only returned if there is a value. |
data.entry.catalog_file_id | string | Entry file ID; only returned if there is a value. |
data.entry.volume_id | string | Volume ID; only returned if there is a value. |
Error response¶
JSON
{
"code": "ErrNotFound",
"msg": "资源不存在",
"data": null
}
| Field | Type | Description |
|---|---|---|
code | string | Error code. |
msg | string | Readable error message. |
data | null | `null` in an error response. |
Follow-up operations¶
Last updated on