Livy Sessions - List Livy Sessions

Odwołanie

Usługa:: Spark

Wersja interfejsu API:: v1

Zwraca listę sesji usługi livy z określonego obszaru roboczego.
Ten interfejs API obsługuje stronicowanie.

Uprawnienia

Obiekt wywołujący musi mieć lub większą rolę obszaru roboczego.

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string	Identyfikator obszaru roboczego.
continuationToken	query		string	Token do pobrania następnej strony wyników, jeśli jest dostępny.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LivySessions	OK — zwraca listę wszystkich sesji usługi livy skojarzonych z elementem itemId.
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd.

Nazwa

Typ

Opis

200 OK

LivySessions

OK — zwraca listę wszystkich sesji usługi livy skojarzonych z elementem itemId.

Other Status Codes

ErrorResponse

Typowe kody błędów:

UnknownError — wystąpił błąd.

Przykłady

List all livy sessions example

Przykładowe żądanie

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f8113ba8-dd81-443e-811a-b385340f3f05/spark/livySessions

Przykładowa odpowiedź

Kod stanu:: 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": "nb_itemName1",
      "itemType": "Notebook",
      "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": ""
    },
    {
      "sparkApplicationId": "application_1730933685452_0001",
      "state": "Cancelled",
      "livyId": "4311f500-bf44-42e0-a0de-78dacb374397",
      "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": "7dee7699-2e81-4121-9a53-cc9025046197",
        "referenceType": "ById"
      },
      "itemName": "lh_itemName2",
      "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": "7dee7699-2e81-4121-9a53-cc9025046197",
        "referenceType": "ById"
      },
      "cancellationReason": "User cancelled the Spark batch",
      "capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
      "operationName": "Batch Livy Run",
      "runtimeVersion": "1.3",
      "livySessionItemResourceUri": ""
    },
    {
      "sparkApplicationId": "application_1730933685452_0001",
      "state": "Cancelled",
      "livyId": "7611f500-bf44-42e0-a0de-78dacb374395",
      "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": "4aee7698-2e81-4121-9a53-cc9025046198",
        "referenceType": "ById"
      },
      "itemName": "sjd_itemName3",
      "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": "4aee7698-2e81-4121-9a53-cc9025046198",
        "referenceType": "ById"
      },
      "cancellationReason": "User cancelled the Spark batch",
      "capacityId": "3c0cd366-dc28-4b6d-a525-4d415a8666e7",
      "operationName": "Batch Livy Run",
      "runtimeVersion": "1.3",
      "livySessionItemResourceUri": ""
    }
  ]
}

Definicje

Nazwa	Opis
Duration	Czas trwania.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
GroupDetails	Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `Group`.
GroupType	Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.
ItemReferenceById	Odwołanie do elementu według obiektu ID.
ItemReferenceType	Typ odwołania do elementu. Dodatkowe typy `ItemReferenceType` można dodawać w czasie.
ItemType	Typ elementu.
JobType	Bieżący stan zadania.
LivySession	Odpowiedź sesji usługi livy
LivySessions	Lista sesji usługi livy z podziałem na strony.
Origin	Źródło zadania.
Principal	Reprezentuje tożsamość lub grupę firmy Microsoft Entra.
PrincipalType	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
ServicePrincipalDetails	Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipal`.
ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipalProfile`.
State	Bieżący stan zadania.
TimeUnit	Jednostka czasu na czas trwania. Dodatkowe typy czasu trwania mogą być dodawane w czasie.
UserDetails	Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `User`.

Duration

Objekt

Czas trwania.

Nazwa	Typ	Opis
timeUnit	TimeUnit	Jednostka czasu na czas trwania. Dodatkowe typy czasu trwania mogą być dodawane w czasie.
value	number	Liczba elementów timeUnits w czasie trwania.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

GroupDetails

Objekt

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.

Nazwa	Typ	Opis
groupType	GroupType	Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

GroupType

Wyliczanie

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

Wartość	Opis
DistributionList	Podmiot zabezpieczeń jest listą dystrybucyjną.
SecurityGroup	Podmiot zabezpieczeń jest grupą zabezpieczeń.
Unknown	Typ grupy podmiotu zabezpieczeń jest nieznany.

ItemReferenceById

Objekt

Odwołanie do elementu według obiektu ID.

Nazwa	Typ	Opis
itemId	string (uuid)	Identyfikator elementu.
referenceType	string: ById	Typ odwołania do elementu.
workspaceId	string (uuid)	Identyfikator obszaru roboczego elementu.

ItemReferenceType

Wyliczanie

Typ odwołania do elementu. Dodatkowe typy ItemReferenceType można dodawać w czasie.

Wartość	Opis
ById	Element jest przywołyyny przez jego identyfikator.

ItemType

Wyliczanie

Typ elementu.

Wartość	Opis
Lakehouse	Element jest elementem lakehouse.
Notebook	Element jest elementem notesu.
SparkJobDefinition	Element jest elementem definicji zadania platformy Spark.

JobType

Wyliczanie

Bieżący stan zadania.

Wartość	Opis
JupyterSession	Typ zadania pochodzi z sesji jupyter.
SparkBatch	Typ zadania pochodzi z partii spark.
SparkSession	Typ zadania pochodzi z sesji platformy Spark.
Unknown	Typ zadania jest nieznany.

LivySession

Objekt

Odpowiedź sesji usługi livy

Nazwa	Typ	Opis
attemptNumber	integer	Bieżący numer próby.
cancellationReason	string	Przyczyna anulowania zadania.
capacityId	string (uuid)	Identyfikator pojemności.
consumerId	Principal	Identyfikator odbiorcy.
creatorItem	ItemReferenceById	Identyfikator twórcy elementu. Jeśli `isHighConcurrency` wartość jest ustawiona na `true` tę wartość, może być inna niż `itemId`.
endDateTime	string (date-time)	Sygnatura czasowa zakończenia zadania w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
isHighConcurrency	boolean	Flaga wskazująca wysoką współbieżność.
item	ItemReferenceById	Identyfikator elementu.
itemName	string	Nazwa elementu.
itemType	ItemType	Typ elementu.
jobInstanceId	string (uuid)	Identyfikator wystąpienia zadania.
jobType	JobType	Bieżący stan zadania.
livyId	string (uuid)	Identyfikator sesji usługi Livy lub partii Livy.
livyName	string	Nazwa sesji usługi Livy lub partii Livy.
livySessionItemResourceUri	string	Identyfikator URI używany do pobierania wszystkich sesji usługi Livy dla danego elementu.
maxNumberOfAttempts	integer	Maksymalna liczba prób.
operationName	string	Nazwa operacji. Możliwe wartości to: Uruchomienie notesu, uruchomienie notesuHC i uruchomienie potoku notesu.
origin	Origin	Źródło zadania.
queuedDuration	Duration	Czas trwania, dla którego zadanie zostało w kolejce.
runningDuration	Duration	Czas uruchomienia zadania.
runtimeVersion	string	Wersja środowiska uruchomieniowego sieci szkieletowej.
sparkApplicationId	string	Identyfikator aplikacji platformy Spark jest unikatowym identyfikatorem przypisanym do każdej aplikacji platformy Apache Spark. Jest on również wyświetlany w interfejsie użytkownika platformy Spark.
startDateTime	string (date-time)	Sygnatura czasowa rozpoczęcia zadania w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
state	State	Bieżący stan zadania.
submittedDateTime	string (date-time)	Sygnatura czasowa przesłania zadania w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
submitter	Principal	Identyfikator przesyłania.
totalDuration	Duration	Całkowity czas trwania zadania.

LivySessions

Objekt

Lista sesji usługi livy z podziałem na strony.

Nazwa	Typ	Opis
continuationToken	string	Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
continuationUri	string	Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
value	LivySession[]	Lista sesji usługi livy.

Origin

Wyliczanie

Źródło zadania.

Wartość	Opis
PendingJob	Zadanie pochodzi z oczekującego źródła danych.
SubmittedJob	Zadanie pochodzi z przesłanego źródła danych.

Principal

Objekt

Reprezentuje tożsamość lub grupę firmy Microsoft Entra.

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń.
groupDetails	GroupDetails	Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `Group`.
id	string (uuid)	Identyfikator podmiotu zabezpieczeń.
servicePrincipalDetails	ServicePrincipalDetails	Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipalProfile`.
type	PrincipalType	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
userDetails	UserDetails	Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `User`.

PrincipalType

Wyliczanie

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

Wartość	Opis
Group	Podmiot zabezpieczeń jest grupą zabezpieczeń.
ServicePrincipal	Jednostka jest jednostką usługi Microsoft Entra.
ServicePrincipalProfile	Jednostka jest profilem jednostki usługi.
User	Podmiot zabezpieczeń jest podmiotem zabezpieczeń użytkownika firmy Microsoft Entra.

ServicePrincipalDetails

Objekt

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.

Nazwa	Typ	Opis
aadAppId	string (uuid)	Jednostka usługi Firmy Microsoft Entra AppId.

ServicePrincipalProfileDetails

Objekt

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.

Nazwa	Typ	Opis
parentPrincipal	Principal	Jednostka nadrzędna profilu jednostki usługi.

State

Wyliczanie

Bieżący stan zadania.

Wartość	Opis
Cancelled	Zadanie zostało anulowane.
Failed	Zadanie nie powiodło się lub upłynął limit czasu sesji.
InProgress	Zadanie jest uruchomione lub jest w stanie anulowania.
NotStarted	Zadanie jest w kolejce, jest uruchamiane lub w stanie pakowania biblioteki.
Succeeded	Zadanie zostało zatrzymane lub jest w stanie powodzenia.
Unknown	Zadanie jest w nieprawidłowym stanie.

TimeUnit

Wyliczanie

Jednostka czasu na czas trwania. Dodatkowe typy czasu trwania mogą być dodawane w czasie.

Wartość	Opis
Days	Czas trwania w dniach.
Hours	Czas trwania w godzinach.
Minutes	Czas trwania w minutach.
Seconds	Czas trwania w sekundach.

UserDetails

Objekt

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.

Nazwa	Typ	Opis
userPrincipalName	string	Główna nazwa użytkownika.

Udostępnij za pośrednictwem

Livy Sessions - List Livy Sessions

Uprawnienia

Wymagane zakresy delegowane

Tożsamości obsługiwane przez Microsoft Entra

Interfejs

Parametry identyfikatora URI

Odpowiedzi

Przykłady

List all livy sessions example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Duration

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemReferenceById

ItemReferenceType

ItemType

JobType

LivySession

LivySessions

Origin

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

State

TimeUnit

UserDetails