Spark Session - Get Spark Sessions

Service:

Synapse

API Version:

2020-12-01

列出在特定 Spark 集區下執行的所有 Spark 工作階段。

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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	工作區開發端點，例如 https://myworkspace.dev.azuresynapse.net。
livyApiVersion	path	True	string	要求的有效 API 版本。
sparkPoolName	path	True	string	Spark 集區的名稱。
detailed	query		boolean	選擇性查詢參數，指定詳細回應是否傳回超過一般 livy。
from	query		integer int32	選擇性參數，指定清單應該從哪個索引開始。
size	query		integer int32	選擇性參數，指定傳回清單的大小。 By default it is 20 and that is the maximum.

回應

名稱	類型	Description
200 OK	SparkSessionCollection	Success

範例

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": []
}

定義

名稱	Description
LivyStates	批次狀態
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	作業類型。
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

批次狀態

名稱	類型	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

名稱	類型	Description
Cleanup	string
Ended	string
Monitoring	string
Preparation	string
Queued	string
ResourceAcquisition	string
Submission	string

SchedulerCurrentState

名稱	類型	Description
Ended	string
Queued	string
Scheduled	string

SparkErrorSource

名稱	類型	Description
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

作業類型。

名稱	類型	Description
SparkBatch	string
SparkSession	string

SparkRequest

名稱	類型	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

名稱	類型	Description
cancellationRequestedAt	string
currentState	SchedulerCurrentState
endedAt	string
scheduledAt	string
submittedAt	string

SparkServiceError

名稱	類型	Description
errorCode	string
message	string
source	SparkErrorSource

SparkServicePlugin

名稱	類型	Description
cleanupStartedAt	string
currentState	PluginCurrentState
monitoringStartedAt	string
preparationStartedAt	string
resourceAcquisitionStartedAt	string
submissionStartedAt	string

SparkSession

名稱	類型	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	會話狀態。
submitterId	string
submitterName	string
tags	object
workspaceName	string

SparkSessionCollection

名稱	類型	Description
from	integer
sessions	SparkSession[]
total	integer

SparkSessionResultType

名稱	類型	Description
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkSessionState

名稱	類型	Description
busyAt	string
currentState	string
deadAt	string
errorAt	string
idleAt	string
jobCreationRequest	SparkRequest
killedAt	string
notStartedAt	string
recoveringAt	string
shuttingDownAt	string
startingAt	string