Spark Session - Get Spark Statements

Service:

Synapse

API Version:

2020-12-01

Gets a list of statements within a spark session.

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

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.

Responses

Name	Type	Description
200 OK	SparkStatementCollection	Success

Examples

Gets a list of statements within a spark session.

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "total_statements": 2,
  "statements": []
}

Definitions

Name	Description
LivyStatementStates
SparkStatement
SparkStatementCollection
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

SparkStatementCollection

Name	Type	Description
statements	SparkStatement[]
total_statements	integer

SparkStatementOutput

Name	Type	Description
data	object
ename	string
evalue	string
execution_count	integer
status	string
traceback	string[]