Spark Session - Get Spark Sessions
列出在特定 Spark 池下运行的所有 Spark 会话。
GET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessionsGET {endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions?from={from}&size={size}&detailed={detailed}URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
工作区开发终结点，例如 |
|
livy
|
path | True |
string |
请求的有效 API 版本。 |
|
spark
|
path | True |
string |
Spark 池的名称。 |
|
detailed
|
query |
boolean |
可选查询参数，指定是否在纯 livy 之外返回详细响应。 |
|
|
from
|
query |
integer (int32) |
可选参数，指定列表应从哪个索引开始。 |
|
|
size
|
query |
integer (int32) |
指定返回列表大小的可选参数。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功 |
示例
List all spark session jobs
示例请求
GET myWorkspace.dev.azuresynapse.net/livyApi/versions/2020-12-01/sparkPools/mySparkPool/sessions?from=0&size=2&detailed=True
示例响应
{
"from": 0,
"total": 2,
"sessions": []
}定义
LivyStates
批处理状态
| 值 | 说明 |
|---|---|
| not_started | |
| starting | |
| idle | |
| busy | |
| shutting_down | |
| error | |
| dead | |
| killed | |
| success | |
| running | |
| recovering |
PluginCurrentState
| 值 | 说明 |
|---|---|
| Preparation | |
| ResourceAcquisition | |
| Queued | |
| Submission | |
| Monitoring | |
| Cleanup | |
| Ended |
SchedulerCurrentState
| 值 | 说明 |
|---|---|
| Queued | |
| Scheduled | |
| Ended |
SparkErrorSource
| 值 | 说明 |
|---|---|
| System | |
| User | |
| Unknown | |
| Dependency |
SparkJobType
作业类型。
| 值 | 说明 |
|---|---|
| SparkBatch | |
| SparkSession |
SparkRequest
| 名称 | 类型 | 说明 |
|---|---|---|
| archives |
string[] |
|
| args |
string[] |
|
| className |
string |
|
| conf |
object |
|
| driverCores |
integer (int32) |
|
| driverMemory |
string |
|
| executorCores |
integer (int32) |
|
| executorMemory |
string |
|
| file |
string |
|
| files |
string[] |
|
| jars |
string[] |
|
| name |
string |
|
| numExecutors |
integer (int32) |
|
| pyFiles |
string[] |
SparkScheduler
| 名称 | 类型 | 说明 |
|---|---|---|
| cancellationRequestedAt |
string (date-time) |
|
| currentState | ||
| endedAt |
string (date-time) |
|
| scheduledAt |
string (date-time) |
|
| submittedAt |
string (date-time) |
SparkServiceError
| 名称 | 类型 | 说明 |
|---|---|---|
| errorCode |
string |
|
| message |
string |
|
| source |
SparkServicePlugin
| 名称 | 类型 | 说明 |
|---|---|---|
| cleanupStartedAt |
string (date-time) |
|
| currentState | ||
| monitoringStartedAt |
string (date-time) |
|
| preparationStartedAt |
string (date-time) |
|
| resourceAcquisitionStartedAt |
string (date-time) |
|
| submissionStartedAt |
string (date-time) |
SparkSession
| 名称 | 类型 | 说明 |
|---|---|---|
| appId |
string |
|
| appInfo |
object |
|
| artifactId |
string |
|
| errorInfo | ||
| id |
integer (int32) |
|
| jobType | ||
| livyInfo | ||
| log |
string[] |
|
| name |
string |
|
| pluginInfo | ||
| result | ||
| schedulerInfo | ||
| sparkPoolName |
string |
|
| state |
会话状态。 |
|
| submitterId |
string |
|
| submitterName |
string |
|
| tags |
object |
|
| workspaceName |
string |
SparkSessionCollection
| 名称 | 类型 | 说明 |
|---|---|---|
| from |
integer (int32) |
|
| sessions | ||
| total |
integer (int32) |
SparkSessionResultType
| 值 | 说明 |
|---|---|
| Uncertain | |
| Succeeded | |
| Failed | |
| Cancelled |
SparkSessionState
| 名称 | 类型 | 说明 |
|---|---|---|
| busyAt |
string (date-time) |
|
| currentState |
string |
|
| deadAt |
string (date-time) |
|
| errorAt |
string (date-time) |
|
| idleAt |
string (date-time) |
|
| jobCreationRequest | ||
| killedAt |
string (date-time) |
|
| notStartedAt |
string (date-time) |
|
| recoveringAt |
string (date-time) |
|
| shuttingDownAt |
string (date-time) |
|
| startingAt |
string (date-time) |