Retrieve a list of running pipelines
Retrieves a list of all the running or finished pipelines (workflows) in your cluster.
Request
The request produces an application/json payload.
POST http://<unravel-host:port>/api/v1/pipelines/list
Example: http://<unravel_host:3000>/api/v1/pipelines/list
Path parameters
Name | Description |
|---|---|
| Specify a list of cluster unique IDs in a comma-separated value. The cluster where the pipeline is running. |
| Specify in which order you want to sort the list of pipelines. Valid values: desc and asc Default: desc |
| Specify the key by which sorting must be done. Default value: startTime |
(Mandatory) | Specify the start time for the search format. Format: Example: |
| Specify the end time for the search format. Format: Example: 2022-08-11T11:14:30.517Z |
| Specify a pipeline or user name to search for the name and owner of the pipeline. |
Query parameters
None
Examples
Request
curl -X POST http://<unravel-host:3000>/api/v1/pipelines/list -H "Content-Type:application/json" -d '{"clusters":["j-1C11K9AFHI0MM", "j-3CJ63WXEMN3LM"],"sort_type":"desc","sort_key":"startTime","start_time":"2022-08-10T18:30:00.000Z","end_time":"2022-08-11T11:14:30.517Z","search_text":""}' -H "Authorization: JWT<token>"
Response
[
{
"averageDuration": 471493.5,
"averageRead": 416640.0,
"averageWrite": 215.0,
"averageResources": "NaN",
"averageEvents": 1.0,
"docCount": 2,
"betterDuration": 18.35,
"betterRead": 0.18,
"betterWrite": 0.0,
"key": "Workflow-user1",
"clusterUid": "45649c7c-e5b4-11ec-b6cf-080027d5f945",
"instances": [
{
"duration": 558031,
"totalDfsBytesWritten": 215,
"startTime": "2022-06-06T17:38:25.000Z",
"numEvents": 1,
"id": "mr-2022-06-06_174918_147000-6501656345312364595",
"userName": "user1",
"totalDfsBytesRead": 415890,
"status": "U"
},
{
"duration": 384956,
"totalDfsBytesWritten": 215,
"startTime": "2022-06-06T15:13:00.000Z",
"numEvents": 1,
"id": "mr-2022-06-06_165021_413000-6476830200489230916",
"userName": "user1",
"totalDfsBytesRead": 417390,
"status": "U"
}
],
"latestInstance": {
"startTime": "2022-06-06T17:38:25.000Z",
"userName": "user1",
"status": "U",
"id": "mr-2022-06-06_174918_147000-6501656345312364595",
"jobId": 0,
"clusterId": null,
"queue": null,
"dbClusterUid": null,
"duration": 558031,
"totalDfsBytesWritten": 215.0,
"totalDfsBytesRead": 415890.0,
"totalResources": 0.0,
"durationDiff": 18.353911559756398,
"totalDfsBytesReadDiff": -0.18001152073732385,
"totalDfsBytesWrittenDiff": 0.0,
"totalResourcesDiff": "NaN",
"costs": 0.0,
"dbus": 0.0,
"remarks": null,
"indicators": {
"duration": "positive",
"read": "negative",
"write": "neutral"
}
}
},
{
"averageDuration": 95917.5,
"averageRead": 83040.0,
"averageWrite": 215.0,
"averageResources": "NaN",
"averageEvents": 1.0,
"docCount": 2,
"betterDuration": 43.47,
"betterRead": 66.65,
"betterWrite": 0.0,
"key": "Workflow-user3",
"clusterUid": "45649c7c-e5b4-11ec-b6cf-080027d5f945",
"instances": [
{
"duration": 137617,
"totalDfsBytesWritten": 215,
"startTime": "2022-06-06T10:50:26.000Z",
"numEvents": 1,
"id": "mr-2022-06-06_165020_199000--1366053751063539576",
"userName": "user3",
"totalDfsBytesRead": 138390,
"status": "U"
},
{
"duration": 54218,
"totalDfsBytesWritten": 215,
"startTime": "2022-06-06T10:44:18.000Z",
"numEvents": 1,
"id": "mr-2022-06-06_165019_660000--1366054356200942945",
"userName": "user3",
"totalDfsBytesRead": 27690,
"status": "U"
}
],
"latestInstance": {
"startTime": "2022-06-06T10:50:26.000Z",
"userName": "user3",
"status": "U",
"id": "mr-2022-06-06_165020_199000--1366053751063539576",
"jobId": 0,
"clusterId": null,
"queue": null,
"dbClusterUid": null,
"duration": 137617,
"totalDfsBytesWritten": 215.0,
"totalDfsBytesRead": 138390.0,
"totalResources": 0.0,
"durationDiff": 43.474339927541905,
"totalDfsBytesReadDiff": 66.65462427745663,
"totalDfsBytesWrittenDiff": 0.0,
"totalResourcesDiff": "NaN",
"costs": 0.0,
"dbus": 0.0,
"remarks": null,
"indicators": {
"duration": "positive",
"read": "positive",
"write": "neutral"
}
}
}
]