Spark Session - Get Spark Session

Služba:

Synapse

Verze rozhraní API:

2020-12-01

Získá jednu relaci Sparku.

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

S volitelnými parametry:

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}?detailed={detailed}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Koncový bod pro vývoj pracovního prostoru, například https://myworkspace.dev.azuresynapse.net.
livyApiVersion	path	True	string	Platná verze rozhraní API pro požadavek
sessionId	path	True	integer int32	Identifikátor relace.
sparkPoolName	path	True	string	Název fondu Spark.
detailed	query		boolean	Volitelný parametr dotazu určující, jestli se podrobná odpověď vrátí nad rámec prosté livy.

Odpovědi

Name	Typ	Description
200 OK	SparkSession	Success

Příklady

Gets a single spark session.

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
LivyStates	Stav dávky
PluginCurrentState
SchedulerCurrentState
SparkErrorSource
SparkJobType	Typ úlohy.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin
SparkSession
SparkSessionResultType
SparkSessionState

LivyStates

Stav dávky

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

Name	Typ	Description
Cleanup	string
Ended	string
Monitoring	string
Preparation	string
Queued	string
ResourceAcquisition	string
Submission	string

SchedulerCurrentState

Name	Typ	Description
Ended	string
Queued	string
Scheduled	string

SparkErrorSource

Name	Typ	Description
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

Typ úlohy.

Name	Typ	Description
SparkBatch	string
SparkSession	string

SparkRequest

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

Name	Typ	Description
cancellationRequestedAt	string
currentState	SchedulerCurrentState
endedAt	string
scheduledAt	string
submittedAt	string

SparkServiceError

Name	Typ	Description
errorCode	string
message	string
source	SparkErrorSource

SparkServicePlugin

Name	Typ	Description
cleanupStartedAt	string
currentState	PluginCurrentState
monitoringStartedAt	string
preparationStartedAt	string
resourceAcquisitionStartedAt	string
submissionStartedAt	string

SparkSession

Name	Typ	Description
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	Stav relace.
submitterId	string
submitterName	string
tags	object
workspaceName	string

SparkSessionResultType

Name	Typ	Description
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkSessionState

Name	Typ	Description
busyAt	string
currentState	string
deadAt	string
errorAt	string
idleAt	string
jobCreationRequest	SparkRequest
killedAt	string
notStartedAt	string
recoveringAt	string
shuttingDownAt	string
startingAt	string