Spark Session - Get Spark Sessions

Layanan:

Synapse

Versi API:

2020-12-01

Cantumkan semua sesi spark yang berjalan di bawah kumpulan spark tertentu.

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir pengembangan ruang kerja, misalnya https://myworkspace.dev.azuresynapse.net.
livyApiVersion	path	True	string	Versi api yang valid untuk permintaan.
sparkPoolName	path	True	string	Nama kumpulan spark.
detailed	query		boolean	Param kueri opsional yang menentukan apakah respons terperinci dikembalikan di luar livy biasa.
from	query		integer int32	Param opsional yang menentukan indeks mana yang harus dimulai oleh daftar.
size	query		integer int32	Param opsional yang menentukan ukuran daftar yang dikembalikan. By default it is 20 and that is the maximum.

Respons

Nama	Jenis	Deskripsi
200 OK	SparkSessionCollection	Berhasil

Contoh

List all spark session jobs

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
LivyStates	Status batch
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	Jenis pekerjaan.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

Status batch

Nama	Jenis	Deskripsi
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

Nama	Jenis	Deskripsi
Cleanup	string
Ended	string
Monitoring	string
Preparation	string
Queued	string
ResourceAcquisition	string
Submission	string

SchedulerCurrentState

Nama	Jenis	Deskripsi
Ended	string
Queued	string
Scheduled	string

SparkErrorSource

Nama	Jenis	Deskripsi
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

Jenis pekerjaan.

Nama	Jenis	Deskripsi
SparkBatch	string
SparkSession	string

SparkRequest

Nama	Jenis	Deskripsi
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

Nama	Jenis	Deskripsi
cancellationRequestedAt	string
currentState	SchedulerCurrentState
endedAt	string
scheduledAt	string
submittedAt	string

SparkServiceError

Nama	Jenis	Deskripsi
errorCode	string
message	string
source	SparkErrorSource

SparkServicePlugin

Nama	Jenis	Deskripsi
cleanupStartedAt	string
currentState	PluginCurrentState
monitoringStartedAt	string
preparationStartedAt	string
resourceAcquisitionStartedAt	string
submissionStartedAt	string

SparkSession

Nama	Jenis	Deskripsi
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	Status sesi.
submitterId	string
submitterName	string
tags	object
workspaceName	string

SparkSessionCollection

Nama	Jenis	Deskripsi
from	integer
sessions	SparkSession[]
total	integer

SparkSessionResultType

Nama	Jenis	Deskripsi
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkSessionState

Nama	Jenis	Deskripsi
busyAt	string
currentState	string
deadAt	string
errorAt	string
idleAt	string
jobCreationRequest	SparkRequest
killedAt	string
notStartedAt	string
recoveringAt	string
shuttingDownAt	string
startingAt	string