Catalog - Search

Usługa:

Core

Wersja interfejsu API:

v1

Interfejs API wyszukiwania wykazu umożliwia programowe odnajdywanie wpisów wykazu usługi OneLake w różnych obszarach roboczych. Obsługuje wyszukiwanie między obszarami roboczymi za pośrednictwem metadanych katalogu i zwraca wyniki filtrowane do wpisów, do których podmiot wywołujący ma uprawnienia dostępu. Wyniki wyszukiwania obejmują stabilne identyfikatory, które mają być używane z uzupełniającymi interfejsami API sieci Szkieletowej w celu pobrania dodatkowych szczegółów lub wykonania obsługiwanych akcji.

Uwaga / Notatka

Wyszukiwanie wykazu jest obecnie dostępne w wersji zapoznawczej (dowiedz się więcej).

CatalogEntry to odnajdywalna reprezentacja metadanych jednostki usługi Microsoft Fabric, która jest obecnie ograniczona do elementów obszaru roboczego. Wpisy wykazu są przeznaczone tylko do odnajdywania metadanych i nie udzielają dostępu do bazowej zawartości danych ani elementów.

Wymagane zakresy delegowane

Catalog.Read.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

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

Ograniczenia

• Funkcja wyszukiwania jest obecnie ograniczona do określonych typów elementów sieci szkieletowej. Następujące typy elementów nie są obsługiwane: Pulpit nawigacyjny, Przepływ danych (Gen1), Przepływ danych (Gen2).

Interfejs

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

Treść żądania

Nazwa	Typ	Opis
continuationToken	string	Element continuationToken dla następnej strony.
filter	string	Filtr wyszukiwania. Obecnie filtr obsługuje filtrowanie według typu wpisów. W miarę upływu czasu można dodać dodatkowe opcje filtru. Parametr filtru obsługuje następujące operatory w celu uściślinia wyników: eq : Równa się; pasuje do dokładnej wartości. ne : nie równa się; wyklucza określoną wartość. lub : logiczny OR; pasuje, jeśli którykolwiek z warunków jest spełniony. ( ) : Nawiasy; wyrażenia grup definiujące hierarchię logiczną.
pageSize	integer	Rozmiar strony, który należy zwrócić. Rozmiar strony musi należeć do zakresu od 1 do 1000.
search	string	Zapytanie tekstowe dotyczące wyszukiwania. To pole obsługuje wyszukiwanie między nazwą wyświetlaną, nazwą wyświetlaną obszaru roboczego i opisem kataloguEntry.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: Brak autoryzacji — brak lub nieprawidłowe uwierzytelnianie Wewnętrzny błąd serwera — nieoczekiwany błąd usługi.

Przykłady

Search example

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

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..."
}

Definicje

Nazwa	Opis
CatalogEntryType	Typ wpisu wykazu. Dodatkowe typy CatalogEntryType można dodawać w czasie.
CatalogQueryRequest	Zapytanie dotyczące wyszukiwania.
CatalogQueryResponse	Wyniki wyszukiwania.
CatalogWorkspace	Obszar roboczy wpisu wykazu.
ErrorRelatedResource	Obiekt szczegółowych informacji o zasobie związanym z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ItemCatalogEntry	Typ elementu sieci szkieletowej wpisu wykazu.
ItemCatalogEntryHierarchy	Bezpośredni przodkowie elementu w architekturze danych Fabric. Zwracane są tylko odpowiednie poziomy.
ItemType	Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

CatalogEntryType

Wyliczenie

Typ wpisu wykazu. Dodatkowe typy CatalogEntryType można dodawać w czasie.

Wartość	Opis
FabricItem	Typ wpisu katalogu elementów sieci szkieletowej.

CatalogQueryRequest

Objekt

Zapytanie dotyczące wyszukiwania.

Nazwa	Typ	Opis
continuationToken	string	Element continuationToken dla następnej strony.
filter	string	Filtr wyszukiwania. Obecnie filtr obsługuje filtrowanie według typu wpisów. W miarę upływu czasu można dodać dodatkowe opcje filtru. Parametr filtru obsługuje następujące operatory w celu uściślinia wyników: eq : Równa się; pasuje do dokładnej wartości. ne : nie równa się; wyklucza określoną wartość. lub : logiczny OR; pasuje, jeśli którykolwiek z warunków jest spełniony. ( ) : Nawiasy; wyrażenia grup definiujące hierarchię logiczną.
pageSize	integer	Rozmiar strony, który należy zwrócić. Rozmiar strony musi należeć do zakresu od 1 do 1000.
search	string	Zapytanie tekstowe dotyczące wyszukiwania. To pole obsługuje wyszukiwanie między nazwą wyświetlaną, nazwą wyświetlaną obszaru roboczego i opisem kataloguEntry.

CatalogQueryResponse

Objekt

Wyniki wyszukiwania.

Nazwa	Typ	Opis
continuationToken	string	Element continuationToken dla następnej strony.
value	CatalogEntry[]: ItemCatalogEntry[]	Lista wpisów wykazu

CatalogWorkspace

Objekt

Obszar roboczy wpisu wykazu.

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana obszaru roboczego.
id	string (uuid)	Identyfikator obszaru roboczego.

ErrorRelatedResource

Objekt

Obiekt szczegółowych informacji o zasobie związanym z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu powiązany z błędem.
resourceType	string	Typ zasobu powiązanego z błędem.

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.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
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 (uuid)	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.

ItemCatalogEntry

Objekt

Typ elementu sieci szkieletowej wpisu wykazu.

Nazwa	Typ	Opis
catalogEntryType	string: FabricItem	Typ wpisu wykazu.
description	string	Opis wpisu wykazu.
displayName	string	Nazwa wyświetlana wpisu wykazu.
hierarchy	ItemCatalogEntryHierarchy	Hierarchia wpisu wykazu.
id	string (uuid)	ObjectId wpisu wykazu.
type	ItemType	Typ elementu sieć szkieletowa.

ItemCatalogEntryHierarchy

Objekt

Bezpośredni przodkowie elementu w architekturze danych Fabric. Zwracane są tylko odpowiednie poziomy.

Nazwa	Typ	Opis
workspace	CatalogWorkspace	Obszar roboczy zawierający element.

ItemType

Wyliczenie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość	Opis
Dashboard	Pulpit nawigacyjny usługi Power BI.
Report	Raport usługi Power BI.
SemanticModel	Model semantyczny usługi PowerBI.
PaginatedReport	Raport podzielony na strony usługi PowerBI.
Datamart	Datamart usługi Power BI.
Lakehouse	Jezioro.
Eventhouse	Magazyn zdarzeń.
Environment	Środowisko.
KQLDatabase	Baza danych KQL.
KQLQueryset	Zestaw zapytań KQL.
KQLDashboard	Pulpit nawigacyjny KQL.
DataPipeline	Potok danych.
Notebook	Zeszyt.
SparkJobDefinition	Definicja zadania platformy Spark.
MLExperiment	Eksperyment uczenia maszynowego.
MLModel	Model uczenia maszynowego.
Warehouse	Magazyn.
Eventstream	Strumień zdarzeń.
SQLEndpoint	Punkt końcowy SQL.
MirroredWarehouse	Dublowany magazyn.
MirroredDatabase	Dublowana baza danych.
Reflex	Refleks.
GraphQLApi	Interfejs API dla elementu GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Baza danych SQLDatabase.
CopyJob	Zadanie kopiowania.
VariableLibrary	ZmiennaLibrary.
Dataflow	Przepływ danych.
ApacheAirflowJob	Zadanie ApacheAirflowJob.
WarehouseSnapshot	Migawka magazynu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Przepływ usługi Digital Twin Builder.
MirroredAzureDatabricksCatalog	Dublowany wykaz usługi Azure Databricks.
Map	Mapa.
AnomalyDetector	Wykrywacz anomalii.
UserDataFunction	Funkcja danych użytkownika.
GraphModel	Model programu Graph.
GraphQuerySet	Zestaw zapytań programu Graph.
SnowflakeDatabase	Baza danych Snowflake do przechowywania tabel góry lodowej utworzonych na podstawie konta Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Baza danych usługi Cosmos DB.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.
AppBackend	Element AppBackend.
OrgApp	Aplikacja organizacji.
OrgAppAudience	Odbiorcy aplikacji organizacji.
DataBuildToolJob	Obiekt DataBuildToolJob.
AzureDatabricksStorage	Element magazynu oparty na usłudze OneLake dla Azure Databricks.
Plan	Plan.