Dela via

Spark Session - Get Spark Session

Tjänst:
Synapse
API-version:
2020-12-01

Hämtar en enda Spark-session.

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}
Med valfria parametrar: 
GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}?detailed={detailed}

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string

Slutpunkten för arbetsytans utveckling, till exempel https://myworkspace.dev.azuresynapse.net.
livyApiVersion
 path True

string

Giltig API-version för begäran.
sessionId
 path True

integer (int32)

Identifierare för sessionen.
sparkPoolName
 path True

string

Namnet på spark-poolen.
detailed
 query

boolean

Valfri frågeparam som anger om ett detaljerat svar returneras bortom oformaterad livy.

Svar

Name Typ Description
200 OK

SparkSession

Framgång

Exempel

Gets a single spark session.

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
LivyStates

Batchtillståndet
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType

Jobbtypen.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionResultType
SparkSessionState

LivyStates

Uppräkning

Batchtillståndet

Värde Description
not_started
starting
idle
busy
shutting_down
error
dead
killed
success
running
recovering

PluginCurrentState

Uppräkning
Värde Description
Preparation
ResourceAcquisition
Queued
Submission
Monitoring
Cleanup
Ended

SchedulerCurrentState

Uppräkning
Värde Description
Queued
Scheduled
Ended

SparkErrorSource

Uppräkning
Värde Description
System
User
Unknown
Dependency

SparkJobType

Uppräkning

Jobbtypen.

Värde Description
SparkBatch
SparkSession

SparkRequest

Objekt
Name Typ Description
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

Objekt
Name Typ Description
cancellationRequestedAt

string (date-time)

currentState

SchedulerCurrentState

endedAt

string (date-time)

scheduledAt

string (date-time)

submittedAt

string (date-time)

SparkServiceError

Objekt
Name Typ Description
errorCode

string

message

string

source

SparkErrorSource

SparkServicePlugin

Objekt
Name Typ Description
cleanupStartedAt

string (date-time)

currentState

PluginCurrentState

monitoringStartedAt

string (date-time)

preparationStartedAt

string (date-time)

resourceAcquisitionStartedAt

string (date-time)

submissionStartedAt

string (date-time)

SparkSession

Objekt
Name Typ Description
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

Sessionstillståndet.
submitterId

string

submitterName

string

tags

object

workspaceName

string

SparkSessionResultType

Uppräkning
Värde Description
Uncertain
Succeeded
Failed
Cancelled

SparkSessionState

Objekt
Name Typ Description
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)