Spark Session - Get Spark Sessions

Usługa:

Synapse

Wersja interfejsu API:

2020-12-01

Wyświetl listę wszystkich sesji platformy Spark uruchomionych w określonej puli spark.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Punkt końcowy programowania obszaru roboczego, na przykład https://myworkspace.dev.azuresynapse.net.
livyApiVersion	path	True	string	Prawidłowa wersja interfejsu API dla żądania.
sparkPoolName	path	True	string	Nazwa puli spark.
detailed	query		boolean	Opcjonalny parametr zapytania określający, czy szczegółowa odpowiedź jest zwracana poza zwykłą usługę livy.
from	query		integer int32	Opcjonalny parametr określający, od którego indeksu powinna zaczynać się lista.
size	query		integer int32	Opcjonalny parametr określający rozmiar zwróconej listy. By default it is 20 and that is the maximum.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SparkSessionCollection	Powodzenie

Przykłady

List all spark session jobs

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
LivyStates	Stan partii
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	Typ zadania.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

Stan partii

Nazwa	Typ	Opis
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

Nazwa	Typ	Opis
Cleanup	string
Ended	string
Monitoring	string
Preparation	string
Queued	string
ResourceAcquisition	string
Submission	string

SchedulerCurrentState

Nazwa	Typ	Opis
Ended	string
Queued	string
Scheduled	string

SparkErrorSource

Nazwa	Typ	Opis
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

Typ zadania.

Nazwa	Typ	Opis
SparkBatch	string
SparkSession	string

SparkRequest

Nazwa	Typ	Opis
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

Nazwa	Typ	Opis
cancellationRequestedAt	string
currentState	SchedulerCurrentState
endedAt	string
scheduledAt	string
submittedAt	string

SparkServiceError

Nazwa	Typ	Opis
errorCode	string
message	string
source	SparkErrorSource

SparkServicePlugin

Nazwa	Typ	Opis
cleanupStartedAt	string
currentState	PluginCurrentState
monitoringStartedAt	string
preparationStartedAt	string
resourceAcquisitionStartedAt	string
submissionStartedAt	string

SparkSession

Nazwa	Typ	Opis
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	Stan sesji.
submitterId	string
submitterName	string
tags	object
workspaceName	string

SparkSessionCollection

Nazwa	Typ	Opis
from	integer
sessions	SparkSession[]
total	integer

SparkSessionResultType

Nazwa	Typ	Opis
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkSessionState

Nazwa	Typ	Opis
busyAt	string
currentState	string
deadAt	string
errorAt	string
idleAt	string
jobCreationRequest	SparkRequest
killedAt	string
notStartedAt	string
recoveringAt	string
shuttingDownAt	string
startingAt	string