Share via

Spark Session - Get Spark Sessions

  • Reference
Service:
Synapse
API Version:
2020-12-01

List all spark sessions which are running under a particular spark pool.

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions
With optional parameters: 
GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions?from={from}&size={size}&detailed={detailed}

URI Parameters

Name In Required Type Description
endpoint
 path True

string

The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.
livyApiVersion
 path True

string

Valid api-version for the request.
sparkPoolName
 path True

string

Name of the spark pool.
detailed
 query

boolean

Optional query param specifying whether detailed response is returned beyond plain livy.
from
 query

integer (int32)

Optional param specifying which index the list should begin from.
size
 query

integer (int32)

Optional param specifying the size of the returned list.

        By default it is 20 and that is the maximum.

Responses

Name Type Description
200 OK

SparkSessionCollection

Success

Examples

List all spark session jobs

Sample request

GET myWorkspace.dev.azuresynapse.net/livyApi/versions/2020-12-01/sparkPools/mySparkPool/sessions?from=0&size=2&detailed=True

Sample response

Status code:
200 
{
  "from": 0,
  "total": 2,
  "sessions": []
}

Definitions

Name Description
LivyStates

The batch state
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType

The job type.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

Enumeration

The batch state

Value Description
busy
dead
error
idle
killed
not_started
recovering
running
shutting_down
starting
success

PluginCurrentState

Enumeration
Value Description
Cleanup
Ended
Monitoring
Preparation
Queued
ResourceAcquisition
Submission

SchedulerCurrentState

Enumeration
Value Description
Ended
Queued
Scheduled

SparkErrorSource

Enumeration
Value Description
Dependency
System
Unknown
User

SparkJobType

Enumeration

The job type.

Value Description
SparkBatch
SparkSession

SparkRequest

Object
Name Type Description
archives

string[]

args

string[]

className

string

conf

object

driverCores

integer (int32)

driverMemory

string

executorCores

integer (int32)

executorMemory

string

file

string

files

string[]

jars

string[]

name

string

numExecutors

integer (int32)

pyFiles

string[]

SparkScheduler

Object
Name Type Description
cancellationRequestedAt

string (date-time)

currentState

SchedulerCurrentState

endedAt

string (date-time)

scheduledAt

string (date-time)

submittedAt

string (date-time)

SparkServiceError

Object
Name Type Description
errorCode

string

message

string

source

SparkErrorSource

SparkServicePlugin

Object
Name Type Description
cleanupStartedAt

string (date-time)

currentState

PluginCurrentState

monitoringStartedAt

string (date-time)

preparationStartedAt

string (date-time)

resourceAcquisitionStartedAt

string (date-time)

submissionStartedAt

string (date-time)

SparkSession

Object
Name Type Description
appId

string

appInfo

object

artifactId

string

errorInfo

SparkServiceError[]

id

integer (int32)

jobType

SparkJobType

livyInfo

SparkSessionState

log

string[]

name

string

pluginInfo

SparkServicePlugin

result

SparkSessionResultType

schedulerInfo

SparkScheduler

sparkPoolName

string

state

LivyStates

The session state.
submitterId

string

submitterName

string

tags

object

workspaceName

string

SparkSessionCollection

Object
Name Type Description
from

integer (int32)

sessions

SparkSession[]

total

integer (int32)

SparkSessionResultType

Enumeration
Value Description
Cancelled
Failed
Succeeded
Uncertain

SparkSessionState

Object
Name Type Description
busyAt

string (date-time)

currentState

string

deadAt

string (date-time)

errorAt

string (date-time)

idleAt

string (date-time)

jobCreationRequest

SparkRequest

killedAt

string (date-time)

notStartedAt

string (date-time)

recoveringAt

string (date-time)

shuttingDownAt

string (date-time)

startingAt

string (date-time)