次の方法で共有

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 バージョン。
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

要求のサンプル

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

列挙

バッチ状態

値 説明
not_started
starting
idle
busy
shutting_down
error
dead
killed
success
running
recovering

PluginCurrentState

列挙
値 説明
Preparation
ResourceAcquisition
Queued
Submission
Monitoring
Cleanup
Ended

SchedulerCurrentState

列挙
値 説明
Queued
Scheduled
Ended

SparkErrorSource

列挙
値 説明
System
User
Unknown
Dependency

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

SparkSessionCollection

Object
名前 型 説明
from

integer (int32)

sessions

SparkSession[]

total

integer (int32)

SparkSessionResultType

列挙
値 説明
Uncertain
Succeeded
Failed
Cancelled

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)