View processing node details

Read the configuration and running snapshot of a product-related processing node.

HTTP
GET $CLOUDSIGMA_API_BASE/lineage/artifacts/{artifact_id}/nodes/{node_id}

Before you call this API

Configure the regional API endpoint and authentication, and select the target workspace.

First query the product processing link, and obtain the product ID and node ID from the response.

The node ID cannot be replaced by the node display name.

Request

Shell
curl "$CLOUDSIGMA_API_BASE/lineage/artifacts/$ARTIFACT_ID/nodes/$NODE_ID" \
  -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 processing result lineage.
node_idstringRequiredNode ID in the processing topology, taken from data.topology.producer_node_id or data.topology.nodes[].node_id.

Successful response

data returns the node identity, selected run record, and run snapshot. When the intermediate node has no persistent output, empty output cannot alone prove that the node is not running.

The response fields are as follows.

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workflow": {
      "workflow_id": "wf-001",
      "workflow_version_id": "ver-001"
    },
    "node": {
      "node_id": "node-001",
      "label": "解析文件",
      "selected_run_id": "run-001",
      "candidate_runs": 1
    },
    "run": {
      "config": {},
      "runtime_input": {},
      "runtime_output": {},
      "status": "success",
      "duration_ms": 10
    }
  }
}
FieldTypeDescription
codestringOK when successful.
msgstringOK when successful.
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.node.node_idstringNode ID.
data.node.labelstringNode display label; only returned if there is a value.
data.node.workitem_type_idstringWork item type ID; returned only if there is a value.
data.node.selected_run_idstringSelected node running record ID; only returned if there is a value.
data.node.parallel_indexintegerParallel index; only returned if there is a value.
data.node.candidate_runsintegerOptional number of running records; only returned if there is a value.
data.run.configobjectNode configuration.
data.run.runtime_inputobjectNode operation input.
data.run.runtime_varsobjectNode operation variables.
data.run.runtime_outputobjectNode operation output.
data.run.statusstringNode running status; only returned if there is a value.
data.run.errorstringNode running error; only returned if there is an error.
data.run.duration_msintegerNode running time (milliseconds); 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

This interface returns node details. If you also want to view processing-result relationships, return to View processing result lineage.

Last updated on