Spark Session - Get Spark Statement

Gets a single statement within a spark session.

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

URI Parameters

Name In Required Type Description
endpoint
path True

string

The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.

livyApiVersion
path True

string

Valid api-version for the request.

sessionId
path True

integer

int32

Identifier for the session.

sparkPoolName
path True

string

Name of the spark pool.

statementId
path True

integer

int32

Identifier for the statement.

Responses

Name Type Description
200 OK

SparkStatement

Success

Examples

Gets a single statement within a spark session.

Sample request

GET myWorkspace.dev.azuresynapse.net/livyApi/versions/2020-12-01/sparkPools/mySparkPool/sessions/123/statements/123

Sample response

{
  "id": 123,
  "code": "fill in here",
  "state": "fill in here",
  "output": null
}

Definitions

Name Description
LivyStatementStates
SparkStatement
SparkStatementOutput

LivyStatementStates

Name Type Description
available

string

cancelled

string

cancelling

string

error

string

running

string

waiting

string

SparkStatement

Name Type Description
code

string

id

integer

output

SparkStatementOutput

state

LivyStatementStates

SparkStatementOutput

Name Type Description
data

object

ename

string

evalue

string

execution_count

integer

status

string

traceback

string[]