Spark Session - Get Spark Sessions

Servicio:

Synapse

Versión de la API:

2020-12-01

Enumere todas las sesiones de Spark que se ejecutan en un grupo de Spark determinado.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Punto de conexión de desarrollo del área de trabajo, por ejemplo https://myworkspace.dev.azuresynapse.net.
livyApiVersion	path	True	string	Versión de API válida para la solicitud.
sparkPoolName	path	True	string	Nombre del grupo de Spark.
detailed	query		boolean	Parámetro de consulta opcional que especifica si se devuelve una respuesta detallada más allá de livy sin formato.
from	query		integer int32	Parámetro opcional que especifica desde qué índice debe comenzar la lista.
size	query		integer int32	Parámetro opcional que especifica el tamaño de la lista devuelta. By default it is 20 and that is the maximum.

Respuestas

Nombre	Tipo	Description
200 OK	SparkSessionCollection	Correcto

Ejemplos

List all spark session jobs

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
LivyStates	Estado del lote
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	El tipo de trabajo.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

Estado del lote

Nombre	Tipo	Description
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

Nombre	Tipo	Description
Cleanup	string
Ended	string
Monitoring	string
Preparation	string
Queued	string
ResourceAcquisition	string
Submission	string

SchedulerCurrentState

Nombre	Tipo	Description
Ended	string
Queued	string
Scheduled	string

SparkErrorSource

Nombre	Tipo	Description
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

El tipo de trabajo.

Nombre	Tipo	Description
SparkBatch	string
SparkSession	string

SparkRequest

Nombre	Tipo	Description
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

Nombre	Tipo	Description
cancellationRequestedAt	string
currentState	SchedulerCurrentState
endedAt	string
scheduledAt	string
submittedAt	string

SparkServiceError

Nombre	Tipo	Description
errorCode	string
message	string
source	SparkErrorSource

SparkServicePlugin

Nombre	Tipo	Description
cleanupStartedAt	string
currentState	PluginCurrentState
monitoringStartedAt	string
preparationStartedAt	string
resourceAcquisitionStartedAt	string
submissionStartedAt	string

SparkSession

Nombre	Tipo	Description
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	Estado de sesión.
submitterId	string
submitterName	string
tags	object
workspaceName	string

SparkSessionCollection

Nombre	Tipo	Description
from	integer
sessions	SparkSession[]
total	integer

SparkSessionResultType

Nombre	Tipo	Description
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkSessionState

Nombre	Tipo	Description
busyAt	string
currentState	string
deadAt	string
errorAt	string
idleAt	string
jobCreationRequest	SparkRequest
killedAt	string
notStartedAt	string
recoveringAt	string
shuttingDownAt	string
startingAt	string