Spark Session - Get Spark Session

Service:

Synapse

API Version:

2020-12-01

Gets a single spark session.

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}

With optional parameters:

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}?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.
sessionId	path	True	integer (int32)	Identifier for the session.
sparkPoolName	path	True	string	Name of the spark pool.
detailed	query		boolean	Optional query param specifying whether detailed response is returned beyond plain livy.

Responses

Name	Type	Description
200 OK	SparkSession	Success

Examples

Gets a single spark session.

Sample request

HTTP

GET myWorkspace.dev.azuresynapse.net/livyApi/versions/2020-12-01/sparkPools/mySparkPool/sessions/123?detailed=True

Sample response

Status code:

200

{
  "livyInfo": null,
  "name": "jobname",
  "workspaceName": "myWorkspace",
  "sparkPoolName": "mySparkPool",
  "submitterName": "thetime",
  "submitterId": "thesubmitterid",
  "artifactId": "fill in here",
  "jobType": "SparkSession",
  "result": "Failed",
  "schedulerInfo": null,
  "pluginInfo": null,
  "errorInfo": [],
  "tags": null,
  "id": 1,
  "appId": "fill in here",
  "appInfo": null,
  "state": "the state",
  "log": []
}

Definitions

Name	Description
LivyStates	The batch state
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	The job type.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionResultType
SparkSessionState

LivyStates

Enumeration

The batch state

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

PluginCurrentState

Enumeration

Value	Description
Preparation
ResourceAcquisition
Queued
Submission
Monitoring
Cleanup
Ended

SchedulerCurrentState

Enumeration

Value	Description
Queued
Scheduled
Ended

SparkErrorSource

Enumeration

Value	Description
System
User
Unknown
Dependency

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

SparkSessionResultType

Enumeration

Value	Description
Uncertain
Succeeded
Failed
Cancelled

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)