次の方法で共有


Spark Session - Get Spark Sessions

特定の 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

Success

List all spark session jobs

要求のサンプル

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

応答のサンプル

{
  "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