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

ParameterTypeRequiredDescription
artifact_idstringRequiredProcessing 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": {}
  }
}
FieldTypeDescription
codestringOK when successful.
msgstringOK when successful.
data.artifact.artifact_idstringProduct ID.
data.artifact.root_asset_idstringRoot data asset ID.
data.artifact.case_idstringAssociation case ID.
data.artifact.parsed_file_availablebooleanWhether the parsed file is available.
data.workflow.workflow_idstringWorkflow ID; returned only if there is a value.
data.workflow.workflow_version_idstringWorkflow version ID; returned only if there is a value.
data.workflow_invocation.inputobjectWorkflow call input; only returned if there is a value.
data.workflow_invocation.varsobjectWorkflow call variables; only returned if there is a value.
data.topology.nodes[]arrayProcessing node, the node can contain node_id, label, status, duration_ms and error.
data.topology.edges[]arrayTopological edge, including source_node_id and target_node_id.
data.topology.producer_node_idstringID of the node that produced the current product; only returned if there is a value.
data.entry.catalog_file_idstringEntry file ID; only returned if there is a value.
data.entry.volume_idstringVolume ID; only returned if there is a value.

Error response

JSON
{
  "code": "ErrNotFound",
  "msg": "资源不存在",
  "data": null
}
FieldTypeDescription
codestringError code.
msgstringReadable error message.
datanull`null` in an error response.

Follow-up operations

View processing node details.

Last updated on