Livy Sessions - Get Livy Session

Служба:: SparkJobDefinition

Версия API:: v1

Возвращает свойства указанного сеанса livy.

Разрешения

Вызывающий объект должен иметь или более поздней роли рабочей области.

Обязательные делегированные области

SparkJobDefinition.Read.All или SparkJobDefinition.ReadWrite.All или Item.Read.All или Item.ReadWrite.All

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
учетные записи службы и управляемые удостоверения	Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions/{sparkJobDefinitionId}/livySessions/{livyId}

Параметры URI

Имя	В	Обязательно	Тип	Описание
livyId	path	True	string	Идентификатор сеанса.
sparkJobDefinitionId	path	True	string (uuid)	Идентификатор sparkJobDefinition.
workspaceId	path	True	string	Идентификатор рабочей области.

Ответы

Имя	Тип	Описание
200 OK	LivySession	ОК- Возвращает сеанс livy по идентификатору.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: SparkCoreSessionNotFound — идентификатор Livy не существует SparkCoreUnexpectedException — необработанное исключение ocurred.

Имя

Тип

Описание

200 OK

LivySession

ОК- Возвращает сеанс livy по идентификатору.

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

SparkCoreSessionNotFound — идентификатор Livy не существует
SparkCoreUnexpectedException — необработанное исключение ocurred.

Примеры

Get a livy session example

Образец запроса

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f8113ba8-dd81-443e-811a-b385340f3f05/sparkJobDefinitions/8cee7699-2e81-4121-9a53-cc9025046193/livySessions/9611f500-bf44-42e0-a0de-78dacb374398

Пример ответа

Код состояния:: 200

{
  "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": "SparkJobDefinition",
  "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
Origin	Источник задания.
Principal	Представляет удостоверение или группу Microsoft Entra.
PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
State	Текущее состояние задания.
TimeUnit	Единица времени для длительности. С течением времени могут добавляться дополнительные типы длительности.
UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.

Duration

Object

Длительность.

Имя	Тип	Описание
timeUnit	TimeUnit	Единица времени для длительности. С течением времени могут добавляться дополнительные типы длительности.
value	number	Количество единиц времени в течение длительности.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

GroupDetails

Object

Группировка конкретных сведений. Применимо, если тип субъекта Group.

Имя	Тип	Описание
groupType	GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.

GroupType

Перечисление

Тип группы. С течением времени могут добавляться дополнительные типы групп.

Значение	Описание
Unknown	Тип основной группы неизвестен.
SecurityGroup	Субъект — это группа безопасности.
DistributionList	Субъект — это список рассылки.

ItemReferenceById

Object

Ссылка на элемент по объекту ID.

Имя	Тип	Описание
itemId	string (uuid)	Идентификатор элемента.
referenceType	string: ById	Тип ссылки на элемент.
workspaceId	string (uuid)	Идентификатор рабочей области элемента.

ItemReferenceType

Перечисление

Ссылочный тип элемента. С течением времени могут добавляться дополнительные ItemReferenceType типы.

Значение	Описание
ById	Элемент ссылается на его идентификатор.

ItemType

Перечисление

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

Значение	Описание
Dashboard	Панель мониторинга PowerBI.
Report	Отчет PowerBI.
SemanticModel	Семантическая модель PowerBI.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Озеро.
Eventhouse	Хранилище событий.
Environment	Среда.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
KQLDashboard	Панель мониторинга KQL.
DataPipeline	Конвейер данных.
Notebook	Записная книжка.
SparkJobDefinition	Определение задания Spark.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
Warehouse	Склад.
Eventstream	Поток событий.
SQLEndpoint	Конечная точка SQL.
MirroredWarehouse	Зеркальный склад.
MirroredDatabase	Зеркальная база данных.
Reflex	Рефлекс.
GraphQLApi	API для элемента GraphQL.
MountedDataFactory	ПодключеннаяdataFactory.
SQLDatabase	База данных SQLDatabase.
CopyJob	Задание копирования.
VariableLibrary	ПеременнаяLibrary.
Dataflow	Поток данных.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Моментальный снимок хранилища.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Поток Конструктора цифровых двойников.
MirroredAzureDatabricksCatalog	Зеркальный каталог azure databricks.

JobType

Перечисление

Текущее состояние задания.

Значение	Описание
Unknown	Тип задания неизвестен.
SparkSession	Тип задания — из сеанса Spark.
SparkBatch	Тип задания — из пакета Spark.
JupyterSession	Тип задания — из сеанса jupyter.

LivySession

Object

Ответ сеанса livy

Имя	Тип	Описание
attemptNumber	integer	Текущий номер попытки.
cancellationReason	string	Причина отмены задания.
capacityId	string (uuid)	Идентификатор емкости.
consumerId	Principal	Идентификатор потребителя.
creatorItem	ItemReferenceById	Идентификатор создателя элемента. Если `isHighConcurrency` задано `true` значение этого значения, может отличаться от `itemId`значения.
endDateTime	string (date-time)	Метка времени окончания задания в формате UTC с использованием формата ГГГГ-ММ-DDTHH:мм:ssZ.
isHighConcurrency	boolean	Флаг, указывающий на высокий параллелизм.
item	ItemReferenceById	Идентификатор элемента.
itemName	string	Имя элемента.
itemType	ItemType	Тип элемента.
jobInstanceId	string (uuid)	Идентификатор экземпляра задания.
jobType	JobType	Текущее состояние задания.
livyId	string (uuid)	Идентификатор сеанса Livy или пакета Livy.
livyName	string	Имя сеанса Livy или пакета Livy.
livySessionItemResourceUri	string	Универсальный код ресурса (URI), используемый для получения всех сеансов Livy для заданного элемента.
maxNumberOfAttempts	integer	Максимальное количество попыток.
operationName	string	Название операции. Возможные значения: запуск записной книжки, запуск HC записной книжки и запуск конвейера записной книжки.
origin	Origin	Источник задания.
queuedDuration	Duration	Длительность, в течение которой задание было поставлено в очередь.
runningDuration	Duration	Время выполнения задания.
runtimeVersion	string	Версия среды выполнения структуры.
sparkApplicationId	string	Идентификатор приложения Spark — это уникальный идентификатор, назначенный каждому приложению Apache Spark. Он также отображается в пользовательском интерфейсе Spark.
startDateTime	string (date-time)	Метка времени при запуске задания в формате UTC с использованием формата YYYY-MM-DDTHH:mm:ssZ.
state	State	Текущее состояние задания.
submittedDateTime	string (date-time)	Метка времени отправки задания в формате UTC с использованием формата ГГГГ-ММ-ДДTHH:мм:ssZ.
submitter	Principal	Идентификатор отправителя.
totalDuration	Duration	Общая длительность задания.

Origin

Перечисление

Источник задания.

Значение	Описание
SubmittedJob	Задание поступает из отправленного источника данных.
PendingJob	Задание поступает из ожидающего источника данных.

Principal

Object

Представляет удостоверение или группу Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
groupDetails	GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalDetails	ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
type	PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
userDetails	UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.

PrincipalType

Перечисление

Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

Значение	Описание
User	Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal	Субъект является субъектом-службой Microsoft Entra.
Group	Субъект — это группа безопасности.
ServicePrincipalProfile	Субъект — это профиль субъекта-службы.

ServicePrincipalDetails

Object

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

Имя	Тип	Описание
aadAppId	string (uuid)	Microsoft Entra AppId субъекта-службы.

ServicePrincipalProfileDetails

Object

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя	Тип	Описание
parentPrincipal	Principal	Родительский субъект профиля субъекта-службы.

State

Перечисление

Текущее состояние задания.

Значение	Описание
InProgress	Задание выполняется или отменяет состояние.
Cancelled	Задание отменено.
NotStarted	Задание находится в очереди, начинается или находится в состоянии упаковки библиотеки.
Succeeded	Задание остановлено или находится в состоянии успешного выполнения.
Failed	Сбой задания или время ожидания сеанса.
Unknown	Задание находится в недопустимом состоянии.

TimeUnit

Перечисление

Единица времени для длительности. С течением времени могут добавляться дополнительные типы длительности.

Значение	Описание
Seconds	Длительность в секундах.
Minutes	Длительность в минутах.
Hours	Длительность в часах.
Days	Длительность в днях.

UserDetails

Object

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

Имя	Тип	Описание
userPrincipalName	string	Основное имя пользователя.

Поделиться через

Livy Sessions - Get Livy Session

Разрешения

Обязательные делегированные области

Поддерживаемые удостоверения Microsoft Entra

Интерфейс

Параметры URI

Ответы

Примеры

Get a livy session example

Образец запроса

Пример ответа

Определения

Duration

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemReferenceById

ItemReferenceType

ItemType

JobType

LivySession

Origin

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

State

TimeUnit

UserDetails