你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Spark Session - Get Spark Sessions

服务:

Synapse

API 版本:

2020-12-01

列出在特定 Spark 池下运行的所有 Spark 会话。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	工作区开发终结点，例如 https://myworkspace.dev.azuresynapse.net 。
livyApiVersion	path	True	string	请求的有效 api-version。
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.

响应

名称	类型	说明
200 OK	SparkSessionCollection	成功

示例

List all spark session jobs

示例请求

HTTP

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

示例响应

状态代码:

200

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

定义

名称	说明
LivyStates	批处理状态
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	作业类型。
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionCollection
SparkSessionResultType
SparkSessionState

LivyStates

批处理状态

名称	类型	说明
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

名称	类型	说明
Cleanup	string
Ended	string
Monitoring	string
Preparation	string
Queued	string
ResourceAcquisition	string
Submission	string

SchedulerCurrentState

名称	类型	说明
Ended	string
Queued	string
Scheduled	string

SparkErrorSource

名称	类型	说明
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

作业类型。

名称	类型	说明
SparkBatch	string
SparkSession	string

SparkRequest

名称	类型	说明
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

名称	类型	说明
cancellationRequestedAt	string
currentState	SchedulerCurrentState
endedAt	string
scheduledAt	string
submittedAt	string

SparkServiceError

名称	类型	说明
errorCode	string
message	string
source	SparkErrorSource

SparkServicePlugin

名称	类型	说明
cleanupStartedAt	string
currentState	PluginCurrentState
monitoringStartedAt	string
preparationStartedAt	string
resourceAcquisitionStartedAt	string
submissionStartedAt	string

SparkSession

名称	类型	说明
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

名称	类型	说明
from	integer
sessions	SparkSession[]
total	integer

SparkSessionResultType

名称	类型	说明
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkSessionState

名称	类型	说明
busyAt	string
currentState	string
deadAt	string
errorAt	string
idleAt	string
jobCreationRequest	SparkRequest
killedAt	string
notStartedAt	string
recoveringAt	string
shuttingDownAt	string
startingAt	string