Share via

Monitoring - Get Spark Job List

Service:
Synapse
API Version:
2020-12-01

Get list of spark applications for the workspace.

GET {endpoint}/monitoring/workloadTypes/spark/Applications?api-version=2020-12-01

URI Parameters

Name In Required Type Description
endpoint
 path True

string

The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.
api-version
 query True

string

Request Header

Name Required Type Description
x-ms-client-request-id

string

Can provide a guid, which is helpful for debugging and to provide better customer support

Responses

Name Type Description
200 OK

SparkJobListViewResponse

Success

Examples

Get list of spark application

Sample request

GET myWorkspace.dev.azuresynapse.net/monitoring/workloadTypes/spark/Applications?api-version=2020-12-01

Sample response

Status code:
200 
{
  "nJobs": 1,
  "sparkJobs": [
    {
      "state": "Failure",
      "name": "sparkjobname",
      "submitter": "submittername",
      "compute": "ComputeName",
      "sparkApplicationId": "sparkApplicationId",
      "livyId": "LivyIdValue",
      "timing": [
        "Ended || Submitting || In Progress",
        "553h 11m"
      ],
      "sparkJobDefinition": null,
      "pipeline": [],
      "jobType": "Spark session || Batch Job",
      "submitTime": "2019-11-11T15:08:52.9554438-08:00",
      "endTime": "2019-11-11T15:08:56.2314317-08:00",
      "queuedDuration": "1s",
      "runningDuration": "2s",
      "totalDuration": "3s"
    }
  ]
}

Definitions

Name Description
SparkJob
SparkJobListViewResponse

SparkJob

Object
Name Type Description
compute

string

endTime

string (date-time)

jobType

string

livyId

string

name

string

pipeline

SparkJob[]

queuedDuration

string

runningDuration

string

sparkApplicationId

string

sparkJobDefinition

string

state

string

submitTime

string (date-time)

submitter

string

timing

string[]

totalDuration

string

SparkJobListViewResponse

Object
Name Type Description
nJobs

integer (int32)

sparkJobs

SparkJob[]