Spark Session - Get Spark Sessions

Servizio:

Synapse

Versione API:

2020-12-01

Elencare tutte le sessioni spark in esecuzione in un particolare pool spark.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint di sviluppo dell'area di lavoro, ad esempio https://myworkspace.dev.azuresynapse.net.
livyApiVersion	path	True	string	Versione api valida per la richiesta.
sparkPoolName	path	True	string	Nome del pool spark.
detailed	query		boolean	Parametro di query facoltativo che specifica se la risposta dettagliata viene restituita oltre la normale livia.
from	query		integer int32	Param facoltativo che specifica quale indice deve iniziare l'elenco.
size	query		integer int32	Param facoltativo che specifica le dimensioni dell'elenco restituito. By default it is 20 and that is the maximum.

Risposte

Nome	Tipo	Descrizione
200 OK	SparkSessionCollection	Operazione riuscita

Esempio

List all spark session jobs

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
LivyStates	Stato del batch
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	Tipo di processo.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

Stato del batch

Nome	Tipo	Descrizione
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

Nome	Tipo	Descrizione
Cleanup	string
Ended	string
Monitoring	string
Preparation	string
Queued	string
ResourceAcquisition	string
Submission	string

SchedulerCurrentState

Nome	Tipo	Descrizione
Ended	string
Queued	string
Scheduled	string

SparkErrorSource

Nome	Tipo	Descrizione
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

Tipo di processo.

Nome	Tipo	Descrizione
SparkBatch	string
SparkSession	string

SparkRequest

Nome	Tipo	Descrizione
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

Nome	Tipo	Descrizione
cancellationRequestedAt	string
currentState	SchedulerCurrentState
endedAt	string
scheduledAt	string
submittedAt	string

SparkServiceError

Nome	Tipo	Descrizione
errorCode	string
message	string
source	SparkErrorSource

SparkServicePlugin

Nome	Tipo	Descrizione
cleanupStartedAt	string
currentState	PluginCurrentState
monitoringStartedAt	string
preparationStartedAt	string
resourceAcquisitionStartedAt	string
submissionStartedAt	string

SparkSession

Nome	Tipo	Descrizione
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	Stato sessione.
submitterId	string
submitterName	string
tags	object
workspaceName	string

SparkSessionCollection

Nome	Tipo	Descrizione
from	integer
sessions	SparkSession[]
total	integer

SparkSessionResultType

Nome	Tipo	Descrizione
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkSessionState

Nome	Tipo	Descrizione
busyAt	string
currentState	string
deadAt	string
errorAt	string
idleAt	string
jobCreationRequest	SparkRequest
killedAt	string
notStartedAt	string
recoveringAt	string
shuttingDownAt	string
startingAt	string