Spark Session - Get Spark Sessions

Service:

Synapse

API Version:

2020-12-01

Belirli bir spark havuzu altında çalışan tüm Spark oturumlarını listeleyin.

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Çalışma alanı geliştirme uç noktası, örneğin https://myworkspace.dev.azuresynapse.net.
livyApiVersion	path	True	string	İstek için geçerli api sürümü.
sparkPoolName	path	True	string	Spark havuzunun adı.
detailed	query		boolean	Ayrıntılı yanıtın düz livy dışında döndürülip döndürülmeyeceğini belirten isteğe bağlı sorgu parametresi.
from	query		integer int32	Listenin hangi dizinden başlayacağını belirten isteğe bağlı parametre.
size	query		integer int32	Döndürülen listenin boyutunu belirten isteğe bağlı param. By default it is 20 and that is the maximum.

Yanıtlar

Name	Tür	Description
200 OK	SparkSessionCollection	Başarılı

Örnekler

List all spark session jobs

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Tanımlar

Name	Description
LivyStates	Toplu iş durumu
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	İş türü.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

Toplu iş durumu

Name	Tür	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	Tür	Description
Cleanup	string
Ended	string
Monitoring	string
Preparation	string
Queued	string
ResourceAcquisition	string
Submission	string

SchedulerCurrentState

Name	Tür	Description
Ended	string
Queued	string
Scheduled	string

SparkErrorSource

Name	Tür	Description
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

İş türü.

Name	Tür	Description
SparkBatch	string
SparkSession	string

SparkRequest

Name	Tür	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	Tür	Description
cancellationRequestedAt	string
currentState	SchedulerCurrentState
endedAt	string
scheduledAt	string
submittedAt	string

SparkServiceError

Name	Tür	Description
errorCode	string
message	string
source	SparkErrorSource

SparkServicePlugin

Name	Tür	Description
cleanupStartedAt	string
currentState	PluginCurrentState
monitoringStartedAt	string
preparationStartedAt	string
resourceAcquisitionStartedAt	string
submissionStartedAt	string

SparkSession

Name	Tür	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	Oturum durumu.
submitterId	string
submitterName	string
tags	object
workspaceName	string

SparkSessionCollection

Name	Tür	Description
from	integer
sessions	SparkSession[]
total	integer

SparkSessionResultType

Name	Tür	Description
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkSessionState

Name	Tür	Description
busyAt	string
currentState	string
deadAt	string
errorAt	string
idleAt	string
jobCreationRequest	SparkRequest
killedAt	string
notStartedAt	string
recoveringAt	string
shuttingDownAt	string
startingAt	string