Livy Sessions - List Livy Sessions

服务:

Lakehouse

API 版本:

v1

从指定的项标识符返回 livy 会话的列表。
此 API 支持 分页。

权限

调用方必须具有 查看器 或更高版本的工作区角色。

所需的委派范围

Lakehouse.Read.All 或 Lakehouse.ReadWrite.All 或 Item.Read.All 或 Item.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	支持
用户	是的
服务主体 和 托管标识	是的

接口

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/livySessions

具有可选参数:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/livySessions?continuationToken={continuationToken}

URI 参数

名称	在	必需	类型	说明
lakehouseId	path	True	string (uuid)	湖屋 ID。
workspaceId	path	True	string	工作区标识符。
continuationToken	query		string	用于检索下一页结果的令牌（如果可用）。

响应

名称	类型	说明
200 OK	LivySessions	确定 - 返回与 itemId 关联的所有 livy 会话的列表。
Other Status Codes	ErrorResponse	常见错误代码： SparkCoreItemNotFound - Lakehouse 标识符不存在 SparkCoreUnexpectedException - 未处理的异常。

示例

List all livy sessions example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f8113ba8-dd81-443e-811a-b385340f3f05/lakehouses/8cee7699-2e81-4121-9a53-cc9025046193/livySessions

示例响应

状态代码:

200

{
  "continuationToken": null,
  "continuationUri": null,
  "value": [
    {
      "sparkApplicationId": "application_1730933685452_0001",
      "state": "Cancelled",
      "livyId": "9611f500-bf44-42e0-a0de-78dacb374398",
      "origin": "SubmittedJob",
      "attemptNumber": 1,
      "maxNumberOfAttempts": 1,
      "livyName": "random_test_name_app",
      "submitter": {
        "id": "6f23a8a6-d954-4550-b91a-4df73ccd0311",
        "type": "User"
      },
      "item": {
        "workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
        "itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
        "referenceType": "ById"
      },
      "itemName": "lh_itemName",
      "itemType": "Lakehouse",
      "jobType": "SparkBatch",
      "submittedDateTime": "2025-01-31T15:32:03Z",
      "startDateTime": "2025-01-31T15:34:11Z",
      "endDateTime": "2025-01-31T15:37:30Z",
      "queuedDuration": {
        "value": 1,
        "timeUnit": "Seconds"
      },
      "runningDuration": {
        "value": 180,
        "timeUnit": "Seconds"
      },
      "totalDuration": {
        "value": 360,
        "timeUnit": "Seconds"
      },
      "jobInstanceId": "c2baabbd-5327-430c-87a6-ff4f98285601",
      "creatorItem": {
        "workspaceId": "f8113ba8-dd81-443e-811a-b385340f3f05",
        "itemId": "8cee7699-2e81-4121-9a53-cc9025046193",
        "referenceType": "ById"
      },
      "cancellationReason": "User cancelled the Spark batch",
      "capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
      "operationName": "Batch Livy Run",
      "runtimeVersion": "1.3",
      "livySessionItemResourceUri": ""
    }
  ]
}

定义

名称	说明
Duration	持续时间。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
GroupDetails	组特定详细信息。 当主体类型 Group时适用。
GroupType	组的类型。 可能会随着时间的推移添加其他组类型。
ItemReferenceById	按 ID 对象引用项。
ItemReferenceType	项引用类型。 可能会随着时间的推移添加其他 ItemReferenceType 类型。
ItemType	项的类型。 可能会随着时间的推移添加其他项类型。
JobType	作业的当前状态。
LivySession	livy 会话响应
LivySessions	livy 会话的分页列表。
Origin	作业的起源。
Principal	表示标识或Microsoft Entra 组。
PrincipalType	主体的类型。 可能会随着时间的推移添加其他主体类型。
ServicePrincipalDetails	服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
ServicePrincipalProfileDetails	服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
State	作业的当前状态。
TimeUnit	持续时间的时间单位。 可能会随着时间的推移添加其他持续时间类型。
UserDetails	用户主体特定详细信息。 当主体类型 User时适用。

Duration

Object

持续时间。

名称	类型	说明
timeUnit	TimeUnit	持续时间的时间单位。 可能会随着时间的推移添加其他持续时间类型。
value	number	持续时间中的 timeUnits 数。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

GroupDetails

Object

组特定详细信息。 当主体类型 Group时适用。

名称	类型	说明
groupType	GroupType	组的类型。 可能会随着时间的推移添加其他组类型。

GroupType

枚举

组的类型。 可能会随着时间的推移添加其他组类型。

值	说明
DistributionList	主体是通讯组列表。
SecurityGroup	主体是安全组。
Unknown	主体组类型未知。

ItemReferenceById

Object

按 ID 对象引用项。

名称	类型	说明
itemId	string (uuid)	项的 ID。
referenceType	string: ById	项引用类型。
workspaceId	string (uuid)	项的工作区 ID。

ItemReferenceType

枚举

项引用类型。 可能会随着时间的推移添加其他 ItemReferenceType 类型。

值	说明
ById	该项的 ID 引用。

ItemType

枚举

项的类型。 可能会随着时间的推移添加其他项类型。

值	说明
CopyJob	复制作业。
Dashboard	PowerBI 仪表板。
DataPipeline	数据管道。
Datamart	PowerBI Datamart。
Environment	环境。
Eventhouse	事件屋。
Eventstream	事件流。
GraphQLApi	GraphQL 项的 API。
KQLDashboard	KQL 仪表板。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
Lakehouse	湖屋
MLExperiment	机器学习试验。
MLModel	机器学习模型。
MirroredDatabase	镜像数据库。
MirroredWarehouse	镜像仓库。
MountedDataFactory	MountedDataFactory。
Notebook	笔记本。
PaginatedReport	PowerBI 分页报表。
Reflex	反射。
Report	PowerBI 报表。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL 终结点。
SemanticModel	PowerBI 语义模型。
SparkJobDefinition	spark 作业定义。
VariableLibrary	VariableLibrary。
Warehouse	仓库。

JobType

枚举

作业的当前状态。

值	说明
JupyterSession	作业类型来自 jupyter 会话。
SparkBatch	作业类型来自 spark 批处理。
SparkSession	作业类型来自 spark 会话。
Unknown	作业类型未知。

LivySession

Object

livy 会话响应

名称	类型	说明
attemptNumber	integer	当前尝试次数。
cancellationReason	string	作业取消的原因。
capacityId	string (uuid)	容量的 ID。
consumerId	Principal	使用者的 ID。
creatorItem	ItemReferenceById	项创建者的 ID。 何时 isHighConcurrency 设置为 true 此值可能不同于 itemId。
endDateTime	string (date-time)	作业以 UTC 结束时的时间戳，使用 YYYY-MM-DDTHH：mm：ssZ 格式。
isHighConcurrency	boolean	指示高并发性的标志。
item	ItemReferenceById	项的 ID。
itemName	string	项的名称。
itemType	ItemType	项目类型。
jobInstanceId	string (uuid)	作业实例的 ID。
jobType	JobType	作业的当前状态。
livyId	string (uuid)	Livy 会话或 Livy 批处理的 ID。
livyName	string	Livy 会话或 Livy 批处理的名称。
livySessionItemResourceUri	string	用于检索给定项的所有 Livy 会话的 URI。
maxNumberOfAttempts	integer	最大尝试次数。
operationName	string	操作的名称。 可能的值包括： 笔记本运行、 Notebook HC 运行 和 笔记本管道运行。
origin	Origin	作业的起源。
queuedDuration	Duration	作业已排队的持续时间。
runningDuration	Duration	运行作业所需的时间。
runtimeVersion	string	构造运行时版本。
sparkApplicationId	string	Spark 应用程序 ID 是分配给每个 Apache Spark 应用程序的唯一标识符。 它还显示在 Spark UI 中。
startDateTime	string (date-time)	作业以 UTC 格式启动时的时间戳，使用 YYYY-MM-DDTHH：mm：ssZ 格式。
state	State	作业的当前状态。
submittedDateTime	string (date-time)	使用 YYYY-MM-DDTHH：mm：ssZ 格式提交作业时的时间戳。
submitter	Principal	提交者的 ID。
totalDuration	Duration	作业的总持续时间。

LivySessions

Object

livy 会话的分页列表。

名称	类型	说明
continuationToken	string	下一个结果集批处理的令牌。 如果没有更多记录，则会从响应中删除该记录。
continuationUri	string	下一个结果集批处理的 URI。 如果没有更多记录，则会从响应中删除该记录。
value	LivySession[]	livy 会话的列表。

Origin

枚举

作业的起源。

值	说明
PendingJob	作业来自挂起的数据源。
SubmittedJob	作业来自提交的数据源。

Principal

Object

表示标识或Microsoft Entra 组。

名称	类型	说明
displayName	string	主体的显示名称。
groupDetails	GroupDetails	组特定详细信息。 当主体类型 Group时适用。
id	string (uuid)	主体的 ID。
servicePrincipalDetails	ServicePrincipalDetails	服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
type	PrincipalType	主体的类型。 可能会随着时间的推移添加其他主体类型。
userDetails	UserDetails	用户主体特定详细信息。 当主体类型 User时适用。

PrincipalType

枚举

主体的类型。 可能会随着时间的推移添加其他主体类型。

值	说明
Group	主体是安全组。
ServicePrincipal	主体是Microsoft Entra 服务主体。
ServicePrincipalProfile	主体是服务主体配置文件。
User	主体是Microsoft Entra 用户主体。

ServicePrincipalDetails

Object

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。

名称	类型	说明
aadAppId	string (uuid)	服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。

名称	类型	说明
parentPrincipal	Principal	服务主体配置文件的父主体。

State

枚举

作业的当前状态。

值	说明
Cancelled	作业被取消。
Failed	作业失败或其会话超时。
InProgress	作业正在运行或正在取消状态。
NotStarted	作业已排队，正在启动或处于库打包状态。
Succeeded	作业已停止或处于成功状态。
Unknown	作业处于无效状态。

TimeUnit

枚举

持续时间的时间单位。 可能会随着时间的推移添加其他持续时间类型。

值	说明
Days	持续时间（以天为单位）。
Hours	持续时间（以小时为单位）。
Minutes	持续时间（以分钟为单位）。
Seconds	持续时间（以秒为单位）。

UserDetails

Object

用户主体特定详细信息。 当主体类型 User时适用。

名称	类型	说明
userPrincipalName	string	用户主体名称。