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)	Το αναγνωριστικό του lakehouse.
workspaceId	path	True	string	Το αναγνωριστικό χώρου εργασίας.
continuationToken	query		string	Διακριτικό για την ανάκτηση της επόμενης σελίδας αποτελεσμάτων, εάν υπάρχει.

Αποκρίσεις

Όνομα	Τύπος	Περιγραφή
200 OK	LivySessions	OK -- Επιστρέφει μια λίστα με όλες τις περιόδους λειτουργίας livy που σχετίζονται με ένα itemId.
Other Status Codes	ErrorResponse	Συνήθεις κωδικοί σφαλμάτων: SparkCoreItemNotFound - Το αναγνωριστικό Lakehouse δεν υπάρχει SparkCoreUnexpectedException - Μη χειριωμένη εξαίρεση που έχει παραληφθεί.

Όνομα

Τύπος

Περιγραφή

200 OK

LivySessions

OK -- Επιστρέφει μια λίστα με όλες τις περιόδους λειτουργίας livy που σχετίζονται με ένα itemId.

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	Ο αριθμός των χρονικών μονάδων στη διάρκεια.

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

Απαρίθμηση

Ο τύπος της ομάδας. Επιπλέον τύποι ομάδων μπορούν να προστεθούν με την πάροδο του χρόνου.

Τιμή	Περιγραφή
DistributionList	Το Principal είναι μια λίστα διανομής.
SecurityGroup	Το Principal είναι μια ομάδα ασφαλείας.
Unknown	Ο κύριος τύπος ομάδας είναι άγνωστος.

ItemReferenceById

Object

Μια αναφορά στοιχείου κατά αντικείμενο ID.

Όνομα	Τύπος	Περιγραφή
itemId	string (uuid)	Το αναγνωριστικό του στοιχείου.
referenceType	string: ById	Ο τύπος αναφοράς στοιχείου.
workspaceId	string (uuid)	Το αναγνωριστικό χώρου εργασίας του στοιχείου.

ItemReferenceType

Απαρίθμηση

Ο τύπος αναφοράς Στοιχείο. Επιπλέον ItemReferenceType τύποι μπορούν να προστεθούν με την πάροδο του χρόνου.

Τιμή	Περιγραφή
ById	Το στοιχείο αναφέρεται από το αναγνωριστικό του.

ItemType

Απαρίθμηση

Ο τύπος του στοιχείου. Επιπλέον τύποι στοιχείων μπορούν να προστεθούν με την πάροδο του χρόνου.

Τιμή	Περιγραφή
CopyJob	Μια εργασία αντιγραφής.
Dashboard	Πίνακας εργαλείων του PowerBI.
DataPipeline	Μια διοχέτευση δεδομένων.
Datamart	Datamart του PowerBI.
Environment	Ένα περιβάλλον.
Eventhouse	Μια εκδήλωση.
Eventstream	Μια ροή συμβάντος.
GraphQLApi	Ένα API για το στοιχείο GraphQL.
KQLDashboard	Ένας πίνακας εργαλείων KQL.
KQLDatabase	Μια βάση δεδομένων KQL.
KQLQueryset	Ένα σύνολο ερωτημάτων KQL.
Lakehouse	Ένα λιμνοθάσπιτο.
MLExperiment	Ένα πείραμα εκμάθησης μηχανής.
MLModel	Ένα μοντέλο εκμάθησης μηχανής.
MirroredDatabase	Μια βάση δεδομένων κατοπτρισμού.
MirroredWarehouse	Μια αποθήκη με κατοπτρικό καθρέφτη.
MountedDataFactory	A MountedDataFactory.
Notebook	Ένα σημειωματάριο.
PaginatedReport	Σελιδοποιημένη αναφορά PowerBI.
Reflex	Αντανακλαστικά.
Report	Αναφορά PowerBI.
SQLDatabase	Μια βάση δεδομένων SQL.
SQLEndpoint	Ένα τελικό σημείο SQL.
SemanticModel	Σημασιολογικό μοντέλο PowerBI.
SparkJobDefinition	Ένας ορισμός εργασίας σπινθήρα.
VariableLibrary	Μια μεταβλητήLibrary.
Warehouse	Μια αποθήκη.

JobType

Απαρίθμηση

Τρέχουσα κατάσταση της εργασίας.

Τιμή	Περιγραφή
JupyterSession	Ο τύπος εργασίας προέρχεται από μια περίοδο λειτουργίας jupyter.
SparkBatch	Ο τύπος εργασίας προέρχεται από μια δέσμη spark.
SparkSession	Ο τύπος εργασίας προέρχεται από μια περίοδο λειτουργίας spark.
Unknown	Ο τύπος εργασίας είναι άγνωστος.

LivySession

Object

Η απόκριση στις περιόδους λειτουργίας livy

Όνομα	Τύπος	Περιγραφή
attemptNumber	integer	Τρέχων αριθμός προσπάθειας.
cancellationReason	string	Αιτία ακύρωσης θέσης εργασίας.
capacityId	string (uuid)	Το αναγνωριστικό των εκχωρημένων πόρων.
consumerId	Principal	Το αναγνωριστικό του καταναλωτή.
creatorItem	ItemReferenceById	Το αναγνωριστικό του δημιουργού του στοιχείου. Όταν `isHighConcurrency` οριστεί σε `true` αυτή την τιμή μπορεί να είναι διαφορετική από `itemId`.
endDateTime	string (date-time)	Χρονική σήμανση όταν η εργασία τερματίστηκε σε μορφή UTC, χρησιμοποιώντας τη μορφή ΕΕΕΕ-ΜΜ-ΗΗH:λλ: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, χρησιμοποιώντας τη μορφή ΕΕΕΕ-ΜΜ-ΗΗH:λλ:ssZ.
state	State	Τρέχουσα κατάσταση της εργασίας.
submittedDateTime	string (date-time)	Χρονική σήμανση κατά την υποβολή της εργασίας σε μορφή UTC, με χρήση της μορφής ΕΕΕΕ-ΜΜ-DDTHH:mm:ssZ.
submitter	Principal	Το αναγνωριστικό του υποβάλλοντε την αίτηση.
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)	Το αναγνωριστικό του διευθυντή.
servicePrincipalDetails	ServicePrincipalDetails	Λεπτομέρειες για την κύρια υπηρεσία. Ισχύει όταν ο κύριος τύπος είναι `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Λεπτομέρειες προφίλ κύριας υπηρεσίας. Ισχύει όταν ο κύριος τύπος είναι `ServicePrincipalProfile`.
type	PrincipalType	Ο τύπος της κύριας. Μπορείτε να προσθέσετε πρόσθετους κύριους τύπους με την πάροδο του χρόνου.
userDetails	UserDetails	Συγκεκριμένες λεπτομέρειες για την κύρια χρήστη. Ισχύει όταν ο κύριος τύπος είναι `User`.

PrincipalType

Απαρίθμηση

Ο τύπος της κύριας. Μπορείτε να προσθέσετε πρόσθετους κύριους τύπους με την πάροδο του χρόνου.

Τιμή	Περιγραφή
Group	Το Principal είναι μια ομάδα ασφαλείας.
ServicePrincipal	Το Principal είναι μια κύρια υπηρεσία Microsoft Entra.
ServicePrincipalProfile	Το Principal είναι ένα προφίλ κύριας υπηρεσίας.
User	Το Principal είναι μια κύρια χρήστης του 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	Το κύριο όνομα χρήστη.

Κοινή χρήση μέσω

Livy Sessions - List Livy Sessions

Δικαιώματα

Απαιτούμενες εμβέλειες με ανάθεση

Υποστηριζόμενες ταυτότητες Microsoft Entra

Διασύνδεση

Παράμετροι URI

Αποκρίσεις

Παραδείγματα

List all livy sessions example

Δείγμα αίτησης

Δείγμα απόκρισης

Ορισμοί

Duration

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemReferenceById

ItemReferenceType

ItemType

JobType

LivySession

LivySessions

Origin

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

State

TimeUnit

UserDetails

Πρόσθετοι πόροι