Spark Batch - Get Spark Batch Jobs

Riferimento

Servizio:: Synapse

Versione API:: 2020-12-01

Elencare tutti i processi batch spark in esecuzione in un determinato pool di spark.

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

Con parametri facoltativi:

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches?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 di spark.
detailed	query		boolean	Parametro di query facoltativo che specifica se la risposta dettagliata viene restituita oltre la normale livy.
from	query		integer int32	Parametro facoltativo che specifica l'indice da cui iniziare l'elenco.
size	query		integer int32	Parametro facoltativo che specifica le dimensioni dell'elenco restituito. `By default it is 20 and that is the maximum.`

Risposte

Nome	Tipo	Descrizione
200 OK	SparkBatchJobCollection	Operazione riuscita

Esempio

List all spark batch jobs

Esempio di richiesta

HTTP

GET myWorkspace.dev.azuresynapse.net/livyApi/versions/2020-12-01/sparkPools/mySparkPool/batches?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
SparkBatchJob
SparkBatchJobCollection	Risposta per l'operazione di elenco batch.
SparkBatchJobResultType	Risultato del processo batch Spark.
SparkBatchJobState
SparkErrorSource
SparkJobType	Tipo di processo.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin

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

SparkBatchJob

Nome	Tipo	Descrizione
appId	string	ID applicazione della sessione
appInfo	object	Informazioni dettagliate sull'applicazione.
artifactId	string	Identificatore dell'artefatto.
errorInfo	SparkServiceError[]	Informazioni sugli errori.
id	integer	ID sessione.
jobType	SparkJobType	Tipo di processo.
livyInfo	SparkBatchJobState
log	string[]	Righe di log.
name	string	Nome del batch.
pluginInfo	SparkServicePlugin	Informazioni sul plug-in.
result	SparkBatchJobResultType	Risultato del processo batch Spark.
schedulerInfo	SparkScheduler	Informazioni sull'utilità di pianificazione.
sparkPoolName	string	Nome del pool di Spark.
state	LivyStates	Stato del batch
submitterId	string	Identificatore del mittente.
submitterName	string	Nome del mittente.
tags	object	Tag.
workspaceName	string	Nome dell'area di lavoro.

SparkBatchJobCollection

Risposta per l'operazione di elenco batch.

Nome	Tipo	Descrizione
from	integer	Indice iniziale delle sessioni recuperate.
sessions	SparkBatchJob[]	Elenco batch
total	integer	Numero di sessioni recuperate.

SparkBatchJobResultType

Risultato del processo batch Spark.

Nome	Tipo	Descrizione
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkBatchJobState

Nome	Tipo	Descrizione
currentState	string	stato del processo Spark.
deadAt	string	tempo in cui lo stato livy "morto" è stato visto per la prima volta.
jobCreationRequest	SparkRequest
killedAt	string	il tempo in cui lo stato livy "ucciso" è stato visto per la prima volta.
notStartedAt	string	l'ora in cui lo stato livy "not_started" è stato visto per la prima volta.
recoveringAt	string	l'ora in cui lo stato livy "ripristinante" è stato visto per la prima volta.
runningAt	string	l'ora in cui lo stato livy "in esecuzione" è stato visto per la prima volta.
startingAt	string	l'ora in cui lo stato livy "iniziale" è stato visto per la prima volta.
successAt	string	l'ora in cui lo stato livy "successo" è stato visto per la prima volta.

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

Condividi tramite