Spark Batch - Get Spark Batch Job

Service:

Synapse

API Version:

2020-12-01

Hämtar ett enda Spark Batch-jobb.

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches/{batchId}

With optional parameters:

GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches/{batchId}?detailed={detailed}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchId	path	True	integer int32	Identifierare för batchjobbet.
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.
sparkPoolName	path	True	string	Namnet på Spark-poolen.
detailed	query		boolean	Valfri frågeparameter som anger om detaljerat svar returneras bortom oformaterad livy.

Svar

Name	Typ	Description
200 OK	SparkBatchJob	Klart

Exempel

Gets a single spark batch job.

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "livyInfo": null,
  "name": "jobname",
  "workspaceName": "myWorkspace",
  "sparkPoolName": "mySparkPool",
  "submitterName": "thetime",
  "submitterId": "thesubmitterid",
  "artifactId": "fill in here",
  "jobType": "SparkBatch",
  "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
SparkBatchJob
SparkBatchJobResultType	Resultatet av Spark-batchjobbet.
SparkBatchJobState
SparkErrorSource
SparkJobType	Jobbtypen.
SparkRequest
SparkScheduler
SparkServiceError
SparkServicePlugin

LivyStates

Batchtillståndet

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

SparkBatchJob

Name	Typ	Description
appId	string	Program-ID för den här sessionen
appInfo	object	Den detaljerade programinformationen.
artifactId	string	Artefaktidentifieraren.
errorInfo	SparkServiceError[]	Felinformationen.
id	integer	Sessions-ID: t.
jobType	SparkJobType	Jobbtypen.
livyInfo	SparkBatchJobState
log	string[]	Loggraderna.
name	string	Batchnamnet.
pluginInfo	SparkServicePlugin	Informationen om plugin-programmet.
result	SparkBatchJobResultType	Resultatet av Spark-batchjobbet.
schedulerInfo	SparkScheduler	Information om schemaläggaren.
sparkPoolName	string	Spark-poolnamnet.
state	LivyStates	Batchtillståndet
submitterId	string	Identifierare för inskickare.
submitterName	string	Inskickarnamnet.
tags	object	Taggarna.
workspaceName	string	Namnet på arbetsytan.

SparkBatchJobResultType

Resultatet av Spark-batchjobbet.

Name	Typ	Description
Cancelled	string
Failed	string
Succeeded	string
Uncertain	string

SparkBatchJobState

Name	Typ	Description
currentState	string	Spark-jobbtillståndet.
deadAt	string	tidpunkt då "döda" liviga tillstånd först sågs.
jobCreationRequest	SparkRequest
killedAt	string	den tid då "dödade" livy staten först sågs.
notStartedAt	string	den tid då "not_started" livy tillstånd först sågs.
recoveringAt	string	den tidpunkt då "återställande" livy tillstånd först sågs.
runningAt	string	den tid då "running" livy tillstånd först sågs.
startingAt	string	den tidpunkt då "start" livy tillstånd först sågs.
successAt	string	den tid då "framgång" livy tillstånd först sågs.

SparkErrorSource

Name	Typ	Description
Dependency	string
System	string
Unknown	string
User	string

SparkJobType

Jobbtypen.

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