Skip to main content

Snowflake Documentation

Retrieve a summary of the pipeline

Retrieves a summary of the specific pipeline. The summary includes:

  • Details of the instances that are running for a specific pipeline

  • Metrics such as duration, I/O data processed, number of apps, number of events, and the number of insights/recommendations for a specific pipeline

Request

The request produces an application/json payload.

GET http://<unravel-host:port>/api/v1/pipelines/<cluster_uid>/<app_id>/annotation

Example: http://<unravel_host:port>/api/v1/pipelines/j-1C11K9AFHI0MM/20220811T063903Z-1896652129783948325/annotation

Path parameters

Name

Description

cluster_uid

Specify the unique IDs of a cluster in a comma-separated value. This is the cluster where the pipeline is running or executed.

app_id

Specify an ID of the pipeline or workflow.

Query parameters

None

Examples

Request 

curl -X GET http://<unravel-host:3000>/api/v1/pipelines/j-1C11K9AFHI0MM/20220811T063903Z-1896652129783948325/annotation  -H "Content-Type:application/json" -H "Authorization: JWT <token>"

Response

{"workflow_name": "bidding_analyser",
"start_time": 1660199972000,
"end_time": 1660200149784,
"instance_json": {"signature":"spark.unravel.workflow.name=bidding_analyser","annotation":{"@class":"com.unraveldata.annotation.WorkflowInstanceAnnotation","source":"post-db","kind":"workflow","status":"S","clusterId":"j-1C11K9AFHI0MM","clusterUid":"j-1C11K9AFHI0MM","duration":177784,"startTime":1660199972000,"submitTime":0,"endTime":0,"totalDfsBytesRead":0,"totalDfsBytesWritten":0,"vcoreSeconds":0,"memorySeconds":0,"numEvents":0,"cents":0.0,"numMRJobs":0,"totalMRJobs":0,"totalMapTasks":0,"sm":0,"km":0,"kmu":0,"fm":0,"fmu":0,"totalReduceTasks":0,"sr":0,"kr":0,"kru":0,"fr":0,"fru":0,"totalMapSlotDuration":0,"totalReduceSlotDuration":0,"queues":["default"],"users":["unravel"],"appIds":[{"key":"spark","value":"application_1660197215849_0037"}],"realUsers":[{"key":"unravel","value":"application_1660197215849_0037"}],"clusterIdMap":[{"key":"j-1C11K9AFHI0MM","value":"j-1C11K9AFHI0MM"}],"numSparkApps":1,"numImpalaApps":0,"numTezApps":0,"numApps":1,"totalSparkTasks":1025,"ss":1025,"ks":0,"ksu":0,"fs":0,"fsu":0,"totalSparkSlotDuration":5994199,"numDatabrickskApps":0},"id":"20220811T063903Z-1896652129783948325","nm":"bidding_analyser","ut":"20220811T063903Z","dt":1660199943000,"hi":0,"wc":[{"ci":"application_1660197215849_0037","ct":"spark","st":1660199950353,"et":1660200149784}],"jobId":0,"runName":null,"numWc":1}}
In this section: