通过

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

Spark Session - Get Spark Session

  • 参考
服务:
Synapse
API 版本:
2020-12-01

获取单个 Spark 会话。

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}
具有可选参数: 
GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}?detailed={detailed}

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string

工作区开发终结点，例如 https://myworkspace.dev.azuresynapse.net。
livyApiVersion
 path True

string

请求的有效 API 版本。
sessionId
 path True

integer (int32)

会话的标识符。
sparkPoolName
 path True

string

Spark 池的名称。
detailed
 query

boolean

可选查询参数，指定是否在纯 livy 之外返回详细响应。

响应

名称 类型 说明
200 OK

SparkSession

成功

示例

Gets a single spark session.

示例请求

GET myWorkspace.dev.azuresynapse.net/livyApi/versions/2020-12-01/sparkPools/mySparkPool/sessions/123?detailed=True

示例响应

状态代码:
200 
{
  "livyInfo": null,
  "name": "jobname",
  "workspaceName": "myWorkspace",
  "sparkPoolName": "mySparkPool",
  "submitterName": "thetime",
  "submitterId": "thesubmitterid",
  "artifactId": "fill in here",
  "jobType": "SparkSession",
  "result": "Failed",
  "schedulerInfo": null,
  "pluginInfo": null,
  "errorInfo": [],
  "tags": null,
  "id": 1,
  "appId": "fill in here",
  "appInfo": null,
  "state": "the state",
  "log": []
}

定义

名称 说明
LivyStates

批处理状态
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType

作业类型。
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionResultType
SparkSessionState

LivyStates

枚举

批处理状态

值 说明
busy
dead
error
idle
killed
not_started
recovering
running
shutting_down
starting
success

PluginCurrentState

枚举
值 说明
Cleanup
Ended
Monitoring
Preparation
Queued
ResourceAcquisition
Submission

SchedulerCurrentState

枚举
值 说明
Ended
Queued
Scheduled

SparkErrorSource

枚举
值 说明
Dependency
System
Unknown
User

SparkJobType

枚举

作业类型。

值 说明
SparkBatch
SparkSession

SparkRequest

Object
名称 类型 说明
archives

string[]

args

string[]

className

string

conf

object

driverCores

integer (int32)

driverMemory

string

executorCores

integer (int32)

executorMemory

string

file

string

files

string[]

jars

string[]

name

string

numExecutors

integer (int32)

pyFiles

string[]

SparkScheduler

Object
名称 类型 说明
cancellationRequestedAt

string (date-time)

currentState

SchedulerCurrentState

endedAt

string (date-time)

scheduledAt

string (date-time)

submittedAt

string (date-time)

SparkServiceError

Object
名称 类型 说明
errorCode

string

message

string

source

SparkErrorSource

SparkServicePlugin

Object
名称 类型 说明
cleanupStartedAt

string (date-time)

currentState

PluginCurrentState

monitoringStartedAt

string (date-time)

preparationStartedAt

string (date-time)

resourceAcquisitionStartedAt

string (date-time)

submissionStartedAt

string (date-time)

SparkSession

Object
名称 类型 说明
appId

string

appInfo

object

artifactId

string

errorInfo

SparkServiceError[]

id

integer (int32)

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

SparkSessionResultType

枚举
值 说明
Cancelled
Failed
Succeeded
Uncertain

SparkSessionState

Object
名称 类型 说明
busyAt

string (date-time)

currentState

string

deadAt

string (date-time)

errorAt

string (date-time)

idleAt

string (date-time)

jobCreationRequest

SparkRequest

killedAt

string (date-time)

notStartedAt

string (date-time)

recoveringAt

string (date-time)

shuttingDownAt

string (date-time)

startingAt

string (date-time)