Spark Session - Get Spark Sessions

Dienst:

Synapse

API-Version:

2020-12-01

Listet alle Spark-Sitzungen auf, die unter einem bestimmten Spark-Pool ausgeführt werden.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Der Endpunkt zur Arbeitsbereichsentwicklung, Beispiel: https://myworkspace.dev.azuresynapse.net
livyApiVersion	path	True	string	Gültige API-Version für die Anforderung,
sparkPoolName	path	True	string	Name des Spark-Pools
detailed	query		boolean	Optionaler Abfrageparameter, der angibt, ob eine detaillierte Antwort über das einfache Livy hinaus zurückgegeben wird.
from	query		integer int32	Optionaler Param, der angibt, mit welchem Index die Liste beginnen soll.
size	query		integer int32	Optionaler Parameter, der die Größe der zurückgegebenen Liste angibt. By default it is 20 and that is the maximum.

Antworten

Name	Typ	Beschreibung
200 OK	SparkSessionCollection	Erfolg

Beispiele

List all spark session jobs

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
LivyStates	Der Batchzustand
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	Der Auftragstyp.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

Der Batchzustand

Name	Typ	Beschreibung
busy	string
dead	string
error	string
idle	string
killed	string
not_started	string
recovering	string
running	string
shutting_down	string
starting	string
success	string

PluginCurrentState

Name	Typ	Beschreibung
Cleanup	string
Ended	string
Monitoring	string
Preparation	string
Queued	string
ResourceAcquisition	string
Submission	string

SchedulerCurrentState

Name	Typ	Beschreibung
Ended	string
Queued	string
Scheduled	string

SparkErrorSource

Name	Typ	Beschreibung
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

Der Auftragstyp.

Name	Typ	Beschreibung
SparkBatch	string
SparkSession	string

SparkRequest

Name	Typ	Beschreibung
archives	string[]
args	string[]
className	string
conf	object
driverCores	integer
driverMemory	string
executorCores	integer
executorMemory	string
file	string
files	string[]
jars	string[]
name	string
numExecutors	integer
pyFiles	string[]

SparkScheduler

Name	Typ	Beschreibung
cancellationRequestedAt	string
currentState	SchedulerCurrentState
endedAt	string
scheduledAt	string
submittedAt	string

SparkServiceError

Name	Typ	Beschreibung
errorCode	string
message	string
source	SparkErrorSource

SparkServicePlugin

Name	Typ	Beschreibung
cleanupStartedAt	string
currentState	PluginCurrentState
monitoringStartedAt	string
preparationStartedAt	string
resourceAcquisitionStartedAt	string
submissionStartedAt	string

SparkSession

Name	Typ	Beschreibung
appId	string
appInfo	object
artifactId	string
errorInfo	SparkServiceError[]
id	integer
jobType	SparkJobType
livyInfo	SparkSessionState
log	string[]
name	string
pluginInfo	SparkServicePlugin
result	SparkSessionResultType
schedulerInfo	SparkScheduler
sparkPoolName	string
state	LivyStates	Der Sitzungszustand.
submitterId	string
submitterName	string
tags	object
workspaceName	string

SparkSessionCollection

Name	Typ	Beschreibung
from	integer
sessions	SparkSession[]
total	integer

SparkSessionResultType

Name	Typ	Beschreibung
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkSessionState

Name	Typ	Beschreibung
busyAt	string
currentState	string
deadAt	string
errorAt	string
idleAt	string
jobCreationRequest	SparkRequest
killedAt	string
notStartedAt	string
recoveringAt	string
shuttingDownAt	string
startingAt	string