Spark Session - Get Spark Sessions

Service:

Synapse

API-versie:

2020-12-01

Vermeld alle Spark-sessies die worden uitgevoerd onder een bepaalde Spark-pool.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Het eindpunt voor werkruimteontwikkeling, bijvoorbeeld https://myworkspace.dev.azuresynapse.net.
livyApiVersion	path	True	string	Geldige API-versie voor de aanvraag.
sparkPoolName	path	True	string	Naam van de spark-pool.
detailed	query		boolean	Optionele queryparameter die aangeeft of een gedetailleerd antwoord wordt geretourneerd buiten gewone livy.
from	query		integer (int32)	Optionele param die aangeeft vanaf welke index de lijst moet beginnen.
size	query		integer (int32)	Optionele param die de grootte van de geretourneerde lijst aangeeft. By default it is 20 and that is the maximum.

Antwoorden

Name	Type	Description
200 OK	SparkSessionCollection	Succes

Voorbeelden

List all spark session jobs

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
LivyStates	De batchstatus
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	Het taaktype.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

Inventarisatie

De batchstatus

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

PluginCurrentState

Inventarisatie

Waarde	Description
Cleanup
Ended
Monitoring
Preparation
Queued
ResourceAcquisition
Submission

SchedulerCurrentState

Inventarisatie

Waarde	Description
Ended
Queued
Scheduled

SparkErrorSource

Inventarisatie

Waarde	Description
Dependency
System
Unknown
User

SparkJobType

Inventarisatie

Het taaktype.

Waarde	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	De sessiestatus.
submitterId	string
submitterName	string
tags	object
workspaceName	string

SparkSessionCollection

Object

Name	Type	Description
from	integer (int32)
sessions	SparkSession[]
total	integer (int32)

SparkSessionResultType

Inventarisatie

Waarde	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)