Spark Batch - Get Spark Batch Jobs

Servicio:

Synapse

Versión de la API:

2020-12-01

Enumere todos los trabajos por lotes de Spark que se ejecutan en un grupo de Spark determinado.

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

Con parámetros opcionales:

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches?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 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	SparkBatchJobCollection	Correcto

Ejemplos

List all spark batch jobs

Solicitud de ejemplo

HTTP

GET myWorkspace.dev.azuresynapse.net/livyApi/versions/2020-12-01/sparkPools/mySparkPool/batches?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
SparkBatchJob
SparkBatchJobCollection	Respuesta para la operación de lista por lotes.
SparkBatchJobResultType	Resultado del trabajo por lotes de Spark.
SparkBatchJobState
SparkErrorSource
SparkJobType	El tipo de trabajo.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin

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

SparkBatchJob

Nombre	Tipo	Description
appId	string	Identificador de aplicación de esta sesión
appInfo	object	La información detallada de la aplicación.
artifactId	string	Identificador del artefacto.
errorInfo	SparkServiceError[]	Información del error.
id	integer	Identificador de sesión.
jobType	SparkJobType	El tipo de trabajo.
livyInfo	SparkBatchJobState
log	string[]	Líneas de registro.
name	string	Nombre del lote.
pluginInfo	SparkServicePlugin	La información del complemento.
result	SparkBatchJobResultType	Resultado del trabajo por lotes de Spark.
schedulerInfo	SparkScheduler	Información del programador.
sparkPoolName	string	Nombre del grupo de Spark.
state	LivyStates	Estado del lote
submitterId	string	Identificador del remitente.
submitterName	string	Nombre del remitente.
tags	object	Las etiquetas.
workspaceName	string	Nombre del área de trabajo.

SparkBatchJobCollection

Respuesta para la operación de lista por lotes.

Nombre	Tipo	Description
from	integer	Índice inicial de sesiones capturadas.
sessions	SparkBatchJob[]	Lista por lotes
total	integer	Número de sesiones capturadas.

SparkBatchJobResultType

Resultado del trabajo por lotes de Spark.

Nombre	Tipo	Description
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkBatchJobState

Nombre	Tipo	Description
currentState	string	estado del trabajo de Spark.
deadAt	string	hora en la que el estado de livy "muerto" fue visto por primera vez.
jobCreationRequest	SparkRequest
killedAt	string	el momento en que el estado de livy "asesinado" fue visto por primera vez.
notStartedAt	string	el momento en que se vio por primera vez el estado de livy "not_started".
recoveringAt	string	el momento en que se vio por primera vez el estado de livy "recuperando".
runningAt	string	la hora en la que se vio por primera vez el estado livy "en ejecución".
startingAt	string	el momento en que se vio por primera vez el estado de livy "iniciando".
successAt	string	el momento en que se vio por primera vez el estado de livy "éxito".

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