Spark Session - Get Spark Sessions

  • Referência
Serviço:
Synapse
Versão da API:
2020-12-01

Liste todas as sessões do Spark que estão em execução num conjunto de spark específico.

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions
Com parâmetros opcionais: 
GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions?from={from}&size={size}&detailed={detailed}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
 path True

string

O ponto final de desenvolvimento da área de trabalho, por exemplo https://myworkspace.dev.azuresynapse.net.
livyApiVersion
 path True

string

Versão de API válida para o pedido.
sparkPoolName
 path True

string

Nome do conjunto spark.
detailed
 query

boolean

Parâmetro de consulta opcional que especifica se a resposta detalhada é devolvida para além do livy simples.
from
 query

integer

int32

Parâmetro opcional que especifica a partir do qual a lista deve começar.
size
 query

integer

int32

Parâmetro opcional que especifica o tamanho da lista devolvida.

        By default it is 20 and that is the maximum.

Respostas

Name Tipo Description
200 OK

SparkSessionCollection

Com êxito

Exemplos

List all spark session jobs

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "from": 0,
  "total": 2,
  "sessions": []
}

Definições

Name Description
LivyStates

O estado do lote
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType

O tipo de tarefa.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

O estado do lote

Name 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

Name Tipo Description
Cleanup

string

Ended

string

Monitoring

string

Preparation

string

Queued

string

ResourceAcquisition

string

Submission

string

SchedulerCurrentState

Name Tipo Description
Ended

string

Queued

string

Scheduled

string

SparkErrorSource

Name Tipo Description
Dependency

string

System

string

Unknown

string

User

string

SparkJobType

O tipo de tarefa.

Name Tipo Description
SparkBatch

string

SparkSession

string

SparkRequest

Name 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

Name Tipo Description
cancellationRequestedAt

string

currentState

SchedulerCurrentState

endedAt

string

scheduledAt

string

submittedAt

string

SparkServiceError

Name Tipo Description
errorCode

string

message

string

source

SparkErrorSource

SparkServicePlugin

Name Tipo Description
cleanupStartedAt

string

currentState

PluginCurrentState

monitoringStartedAt

string

preparationStartedAt

string

resourceAcquisitionStartedAt

string

submissionStartedAt

string

SparkSession

Name 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

O estado da sessão.
submitterId

string

submitterName

string

tags

object

workspaceName

string

SparkSessionCollection

Name Tipo Description
from

integer

sessions

SparkSession[]

total

integer

SparkSessionResultType

Name Tipo Description
Cancelled

string

Failed

string

Succeeded

string

Uncertain

string

SparkSessionState

Name Tipo Description
busyAt

string

currentState

string

deadAt

string

errorAt

string

idleAt

string

jobCreationRequest

SparkRequest

killedAt

string

notStartedAt

string

recoveringAt

string

shuttingDownAt

string

startingAt

string