Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
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}/statementsURI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
The workspace development endpoint, for example |
|
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 |
Success |
Examples
Gets a list of statements within a spark session.
Sample request
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
Enumeration
| Value | Description |
|---|---|
| waiting | |
| running | |
| available | |
| error | |
| cancelling | |
| cancelled |
SparkStatement
Object
| Name | Type | Description |
|---|---|---|
| code |
string |
|
| id |
integer (int32) |
|
| output | ||
| state |
SparkStatementCollection
Object
| Name | Type | Description |
|---|---|---|
| statements | ||
| total_statements |
integer (int32) |
SparkStatementOutput
Object
| Name | Type | Description |
|---|---|---|
| data |
object |
|
| ename |
string |
|
| evalue |
string |
|
| execution_count |
integer (int32) |
|
| status |
string |
|
| traceback |
string[] |