Catalog - Search

Υπηρεσία:: Core

Έκδοση API:: v1

Το API αναζήτησης Catalog επιτρέπει τον προγραμματισμό εντοπισμού καταχωρήσεων καταλόγου OneLake σε πολλούς χώρους εργασίας. Υποστηρίζει αναζήτηση μεταξύ χώρων εργασίας μέσω μετα-δεδομένων καταλόγου και επιστρέφει αποτελέσματα φιλτραρισμένα σε καταχωρήσεις στις οποίες εξουσιοδοτείται η κύρια κλήση για πρόσβαση. Τα αποτελέσματα αναζήτησης περιλαμβάνουν σταθερά αναγνωριστικά που προορίζονται να χρησιμοποιηθούν με συμπληρωματικά API Fabric για την ανάκτηση πρόσθετων λεπτομερειών ή την εκτέλεση υποστηριζόμενων ενεργειών.

Σημείωμα

Η αναζήτηση καταλόγου βρίσκεται αυτήν τη στιγμή σε προεπισκόπηση (μάθετε περισσότερα).

Ένα CatalogEntry είναι μια αναπαράσταση μετα-δεδομένων με δυνατότητα εντοπισμού μιας οντότητας Microsoft Fabric, η οποία αυτήν τη στιγμή περικλείεται σε στοιχεία χώρου εργασίας. Οι καταχωρήσεις καταλόγου προορίζονται μόνο για εντοπισμό μετα-δεδομένων και δεν εκχωρούν πρόσβαση σε υποκείμενα δεδομένα ή περιεχόμενο στοιχείου.

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

Catalog.Read.All

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

Αυτό το API υποστηρίζει τις ταυτότητες Microsoft που παρατίθενται σε αυτή την ενότητα.

Ταυτότητα	Υποστήριξη
Χρήστης	Ναι
Υπηρεσίας και διαχειριζόμενες ταυτότητες	Ναι

Περιορισμοί

Η λειτουργικότητα αναζήτησης αυτήν τη στιγμή περικλείεται σε συγκεκριμένους τύπους στοιχείων Fabric. Δεν υποστηρίζονται οι ακόλουθοι τύποι στοιχείων: Πίνακας εργαλείων, Ροή δεδομένων (Gen1), Ροή δεδομένων (Gen2).

Διεπαφή

POST https://api.fabric.microsoft.com/v1/catalog/search

Κυρίως τμήμα αίτησης

Όνομα	Τύπος	Περιγραφή
continuationToken	string	Η συνέχειαToken για την επόμενη σελίδα.
filter	string	Το φίλτρο για την αναζήτηση. Προς το παρόν, το φίλτρο υποστηρίζει φιλτράρισμα κατά τύπο καταχωρήσεων. Ενδέχεται να προστεθούν πρόσθετες επιλογές φίλτρου με την πάροδο του χρόνου. Η παράμετρος filter υποστηρίζει τους ακόλουθους τελεστές για τη βελτίωση των αποτελεσμάτων: eq : Ισούται με; αντιστοιχεί την ακριβή τιμή. ne : Δεν ισούται με; Εξαιρεί την καθορισμένη τιμή. ή : Λογικό OR; αντιστοίχιση εάν οποιαδήποτε από τις συνθήκες είναι αληθής. ( ) : Παρενθέσεις το ομαδοποιεί παραστάσεις για τον ορισμό λογικής ιεραρχίας.
pageSize	integer	Το μέγεθος σελίδας που πρέπει να επιστραφεί. Το μέγεθος σελίδας πρέπει να είναι μεταξύ 1 και 1000.
search	string	Το ερώτημα κειμένου για την αναζήτηση. Αυτό το πεδίο υποστηρίζει αναζήτηση στο εμφανιζόμενο όνομα, το εμφανιζόμενο όνομα χώρου εργασίας και την περιγραφή του CatalogEntry.

Αποκρίσεις

Όνομα Τύπος Περιγραφή

200 OK

Όνομα	Τύπος	Περιγραφή
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	Έγινε υπέρβαση του ορίου επιτοκίου υπηρεσίας. Ο διακομιστής επιστρέφει μια `Retry-After` κεφαλίδα που υποδεικνύει, σε δευτερόλεπτα, πόσο πρέπει να περιμένει ο υπολογιστής-πελάτης πριν από την αποστολή πρόσθετων αιτήσεων. Κεφαλίδες Retry-After: integer
Other Status Codes	ErrorResponse	Συνήθεις κωδικοί σφαλμάτων: Μη εξουσιοδοτημένος - Λείπει ή δεν έχει ενεργοποιηθεί ο έλεγχος ταυτότητας Σφάλμα εσωτερικού διακομιστή - Μη αναμενόμενη αποτυχία υπηρεσίας.

CatalogQueryResponse

429 Too Many Requests

ErrorResponse

Έγινε υπέρβαση του ορίου επιτοκίου υπηρεσίας. Ο διακομιστής επιστρέφει μια Retry-After κεφαλίδα που υποδεικνύει, σε δευτερόλεπτα, πόσο πρέπει να περιμένει ο υπολογιστής-πελάτης πριν από την αποστολή πρόσθετων αιτήσεων.

Κεφαλίδες

Retry-After: integer

Other Status Codes

ErrorResponse

Συνήθεις κωδικοί σφαλμάτων:

Μη εξουσιοδοτημένος - Λείπει ή δεν έχει ενεργοποιηθεί ο έλεγχος ταυτότητας
Σφάλμα εσωτερικού διακομιστή - Μη αναμενόμενη αποτυχία υπηρεσίας.

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

Search example

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

HTTP

POST https://api.fabric.microsoft.com/v1/catalog/search

{
  "search": "Sales Revenue",
  "pageSize": 2,
  "filter": "Type eq 'Report' or Type eq 'Lakehouse'"
}

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

Κωδικός κατάστασης:: 200

{
  "value": [
    {
      "id": "0acd697c-1550-43cd-b998-91bfb12347c6",
      "type": "Report",
      "catalogEntryType": "FabricItem",
      "displayName": "Monthly Sales Revenue",
      "description": "Consolidated revenue report for the current fiscal year.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    },
    {
      "id": "5e8f2a1b-9c3d-4e7f-b6a5-d4c3b2a1e0f9",
      "type": "Lakehouse",
      "catalogEntryType": "FabricItem",
      "displayName": "Sales Revenue Lakehouse",
      "description": "Central lakehouse for sales transaction data.",
      "hierarchy": {
        "workspace": {
          "id": "a2b3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d",
          "displayName": "Finance Platform"
        }
      }
    }
  ],
  "continuationToken": "eyJza2lwIjoyLCJ0YWtl..."
}

Ορισμοί

Όνομα	Περιγραφή
CatalogEntryType	Ο τύπος καταχώρησης καταλόγου. Επιπλέον `CatalogEntryType` τύποι μπορούν να προστεθούν με την πάροδο του χρόνου.
CatalogQueryRequest	Το ερώτημα για την αναζήτηση.
CatalogQueryResponse	Τα αποτελέσματα της αναζήτησης.
CatalogWorkspace	Ο χώρος εργασίας για την καταχώρηση καταλόγου.
ErrorRelatedResource	Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.
ErrorResponse	Η απόκριση σφάλματος.
ErrorResponseDetails	Οι λεπτομέρειες της απόκρισης σφάλματος.
ItemCatalogEntry	Ένας τύπος στοιχείου Fabric μιας καταχώρησης καταλόγου.
ItemCatalogEntryHierarchy	Οι άμεσοι προγόνοι του στοιχείου στην αρχιτεκτονική δεδομένων του Fabric. Επιστρέφονται μόνο τα ισχύοντα επίπεδα.
ItemType	Ο τύπος του στοιχείου. Επιπλέον τύποι στοιχείων μπορούν να προστεθούν με την πάροδο του χρόνου.

CatalogEntryType

Απαρίθμηση

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

Τιμή	Περιγραφή
FabricItem	Ένας τύπος καταχώρησης καταλόγου στοιχείων Fabric.

CatalogQueryRequest

Αντικείμενο

Το ερώτημα για την αναζήτηση.

Όνομα	Τύπος	Περιγραφή
continuationToken	string	Η συνέχειαToken για την επόμενη σελίδα.
filter	string	Το φίλτρο για την αναζήτηση. Προς το παρόν, το φίλτρο υποστηρίζει φιλτράρισμα κατά τύπο καταχωρήσεων. Ενδέχεται να προστεθούν πρόσθετες επιλογές φίλτρου με την πάροδο του χρόνου. Η παράμετρος filter υποστηρίζει τους ακόλουθους τελεστές για τη βελτίωση των αποτελεσμάτων: eq : Ισούται με; αντιστοιχεί την ακριβή τιμή. ne : Δεν ισούται με; Εξαιρεί την καθορισμένη τιμή. ή : Λογικό OR; αντιστοίχιση εάν οποιαδήποτε από τις συνθήκες είναι αληθής. ( ) : Παρενθέσεις το ομαδοποιεί παραστάσεις για τον ορισμό λογικής ιεραρχίας.
pageSize	integer	Το μέγεθος σελίδας που πρέπει να επιστραφεί. Το μέγεθος σελίδας πρέπει να είναι μεταξύ 1 και 1000.
search	string	Το ερώτημα κειμένου για την αναζήτηση. Αυτό το πεδίο υποστηρίζει αναζήτηση στο εμφανιζόμενο όνομα, το εμφανιζόμενο όνομα χώρου εργασίας και την περιγραφή του CatalogEntry.

CatalogQueryResponse

Αντικείμενο

Τα αποτελέσματα της αναζήτησης.

Όνομα	Τύπος	Περιγραφή
continuationToken	string	Η συνέχειαToken για την επόμενη σελίδα.
value	CatalogEntry[]: ItemCatalogEntry[]	Μια λίστα καταχωρήσεων καταλόγου

CatalogWorkspace

Αντικείμενο

Ο χώρος εργασίας για την καταχώρηση καταλόγου.

Όνομα	Τύπος	Περιγραφή
displayName	string	Το εμφανιζόμενο όνομα του χώρου εργασίας.
id	string (uuid)	Το αναγνωριστικό του χώρου εργασίας.

ErrorRelatedResource

Αντικείμενο

Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.

Όνομα	Τύπος	Περιγραφή
resourceId	string	Το αναγνωριστικό πόρου που εμπλέκεται στο σφάλμα.
resourceType	string	Ο τύπος του πόρου που εμπλέκεται στο σφάλμα.

ErrorResponse

Αντικείμενο

Η απόκριση σφάλματος.

Όνομα	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
isRetriable	boolean	Όταν είναι true, η αίτηση μπορεί να επαναληφθεί. Χρησιμοποιήστε την `Retry-After` κεφαλίδα απόκρισης για να προσδιορίσετε την καθυστέρηση, εάν υπάρχει.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
moreDetails	ErrorResponseDetails[]	Λίστα πρόσθετων λεπτομερειών σφάλματος.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.
requestId	string (uuid)	Το αναγνωριστικό της αίτησης που σχετίζεται με το σφάλμα.

ErrorResponseDetails

Αντικείμενο

Οι λεπτομέρειες της απόκρισης σφάλματος.

Όνομα	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.

ItemCatalogEntry

Αντικείμενο

Ένας τύπος στοιχείου Fabric μιας καταχώρησης καταλόγου.

Όνομα	Τύπος	Περιγραφή
catalogEntryType	string: FabricItem	Ο τύπος καταχώρησης καταλόγου.
description	string	Η περιγραφή της καταχώρησης καταλόγου.
displayName	string	Το εμφανιζόμενο όνομα της καταχώρησης καταλόγου.
hierarchy	ItemCatalogEntryHierarchy	Η ιεραρχία της καταχώρησης καταλόγου.
id	string (uuid)	Το objectId της καταχώρησης καταλόγου.
type	ItemType	Ο τύπος στοιχείου Fabric.

ItemCatalogEntryHierarchy

Αντικείμενο

Οι άμεσοι προγόνοι του στοιχείου στην αρχιτεκτονική δεδομένων του Fabric. Επιστρέφονται μόνο τα ισχύοντα επίπεδα.

Όνομα	Τύπος	Περιγραφή
workspace	CatalogWorkspace	Ο χώρος εργασίας που περιέχει το στοιχείο.

ItemType

Απαρίθμηση

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

Τιμή	Περιγραφή
Dashboard	Πίνακας εργαλείων του PowerBI.
Report	Αναφορά PowerBI.
SemanticModel	Σημασιολογικό μοντέλο PowerBI.
PaginatedReport	Σελιδοποιημένη αναφορά PowerBI.
Datamart	Datamart του PowerBI.
Lakehouse	Ένα λιμνοθάσπιτο.
Eventhouse	Μια εκδήλωση.
Environment	Ένα περιβάλλον.
KQLDatabase	Μια βάση δεδομένων KQL.
KQLQueryset	Ένα σύνολο ερωτημάτων KQL.
KQLDashboard	Ένας πίνακας εργαλείων KQL.
DataPipeline	Μια διοχέτευση δεδομένων.
Notebook	Ένα σημειωματάριο.
SparkJobDefinition	Ένας ορισμός εργασίας σπινθήρα.
MLExperiment	Ένα πείραμα εκμάθησης μηχανής.
MLModel	Ένα μοντέλο εκμάθησης μηχανής.
Warehouse	Μια αποθήκη.
Eventstream	Μια ροή συμβάντος.
SQLEndpoint	Ένα τελικό σημείο SQL.
MirroredWarehouse	Μια αποθήκη με κατοπτρικό καθρέφτη.
MirroredDatabase	Μια βάση δεδομένων κατοπτρισμού.
Reflex	Αντανακλαστικά.
GraphQLApi	Ένα API για το στοιχείο GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Μια βάση δεδομένων SQL.
CopyJob	Μια εργασία αντιγραφής.
VariableLibrary	Μια μεταβλητήLibrary.
Dataflow	Μια ροή δεδομένων.
ApacheAirflowJob	Ένα ApacheAirflowJob.
WarehouseSnapshot	Ένα στιγμιότυπο αποθήκης.
DigitalTwinBuilder	Μια DigitalTwinBuilder.
DigitalTwinBuilderFlow	Μια ψηφιακή ροή Twin Builder.
MirroredAzureDatabricksCatalog	Ένας κατοπτρικός κατάλογος azure databricks.
Map	Ένας χάρτης.
AnomalyDetector	Ένας εντοπισμός ανωμαλιών.
UserDataFunction	Μια συνάρτηση δεδομένων χρήστη.
GraphModel	Ένα GraphModel.
GraphQuerySet	Ένα σύνολο ερωτημάτων Graph.
SnowflakeDatabase	Μια βάση δεδομένων Snowflake για την αποθήκευση πινάκων Iceberg που δημιουργήθηκαν από τον λογαριασμό Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Μια βάση δεδομένων Cosmos DB.
Ontology	Μια ογκολογία.
EventSchemaSet	Ένα EventSchemaSet.
DataAgent	Ένας DataAgent.
MirroredCatalog	Ένα Κατοπτρικό Αρχείο.
AppBackend	Ένα AppBackend.
OrgApp	Μια εφαρμογή οργανισμού.
OrgAppAudience	Ένα κοινό εφαρμογής οργανισμού.
DataBuildToolJob	Ένα DataBuildToolJob.
AzureDatabricksStorage	Ένα στοιχείο αποθήκευσης που υποστηρίζεται από το OneLake για Azure Databricks.
Plan	Ένα σχέδιο.