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.

Permissions

Obiekt wywołujący może odnajdywać tylko wpisy wykazu dla obszarów roboczych i elementów, do których obiekt wywołujący ma uprawnienia dostępu.

Wymagane zakresy delegowane

Catalog.Read.All

Ograniczenia

  • continuationToken nie może być łączone z search lub filter. Token już przenosi te wartości z żądania źródłowego.

  • pageSize musi należeć do zakresu od 1 do 1000.

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

Interfejs

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

Treść żądania

Nazwisko Typ Opis
continuationToken

string

Token kontynuacji następnej strony.

Token kontynuacji przekazuje element search, filteri pageSize oryginalnego żądania, więc może zostać wysłany samodzielnie. Nie może być połączony z tym samym żądaniem search lub filter w tym samym żądaniu; w ten sposób zwracany jest błąd.
filter

string

Filtr wyszukiwania. W miarę upływu czasu można dodać dodatkowe opcje filtru.

Parametr filtru obsługuje następujące właściwości:

  • Typ: pasuje do type właściwości wpisu wykazu, na przykład Report, Lakehouselub Workspace. Pojedynczy filtr może określać maksymalnie 500 wartości typu, z których każdy ma długość do 50 znaków.

  • WorkspaceId: identyfikator obszaru roboczego, który zawiera wpis wykazu. Jeden filtr może określać co najwyżej 12 wartości WorkspaceId, z których każdy musi być prawidłowym identyfikatorem GUID.

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ść.

  • and: Logical AND; pasuje tylko wtedy, gdy wszystkie warunki są spełnione.

  • 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. Wartość domyślna to 50.
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.

Pole wyszukiwania obsługuje następujące operatory:

  • " " : Podwójne cudzysłowy; dopasuj ujęte wyrazy jako dokładną frazę.

  • * : gwiazdka; symbol wieloznaczny odpowiadający zero lub więcej znaków.

  • ? : Znak zapytania; symbol wieloznaczny pasujący do pojedynczego znaku.

  • &: Double ampersands; wymaga każdego terminu wyszukiwania.

  • Podkreślenia są traktowane jako część terminu wyszukiwania; nie jest wymagane żadne ucieczki.

  • Inne znaki specjalne są ignorowane i traktowane jako separatory.

Odpowiedzi

Nazwisko 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:

  • InvalidRequest — treść żądania nie została podana lub jest w inny sposób nieprawidłowa.

  • InvalidSearch — search nie można przeanalizować wartości.

  • InvalidFilter — filter nie można przeanalizować wartości lub wartość filtru jest źle sformułowana lub przekracza maksymalną długość.

  • InvalidFilterProperty — filter odwołuje się do właściwości, która nie jest obsługiwana.

  • FilterTooManyValues — filter określa więcej wartości dla właściwości, niż ta właściwość zezwala.

  • FilterNotSupported — filtrowanie nie jest obsługiwane.

  • ConflictingFilterParameters — continuationToken został połączony z parametrem search lub filter.

  • InvalidPageSize — pageSize znajduje się poza zakresem od 1 do 1000.

  • InvalidContinuationToken — wartość jest nieprawidłowa continuationToken .

  • ContinuationTokenTooLong — continuationToken wartość przekracza maksymalną długość.

  • TypeNotFound — filter odwołuje się do typu elementu, który nie istnieje.

  • Brak autoryzacji — brak lub nieprawidłowe uwierzytelnianie

  • Wewnętrzny błąd serwera — nieoczekiwany błąd usługi.

Przykłady

Search example
Search within a workspace example

Search example

Przykładowe żądanie

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

{
  "search": "sales",
  "pageSize": 3,
  "filter": "Type eq 'Report' or Type eq 'Lakehouse' or Type eq 'Workspace'"
}

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"
        }
      }
    },
    {
      "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
      "type": "Workspace",
      "catalogEntryType": "Workspace",
      "displayName": "Sales Analytics",
      "description": "Workspace for the sales analytics team."
    }
  ],
  "continuationToken": "eyJza2lwIjozLCJ0YWtl..."
}

Search within a workspace example

Przykładowe żądanie

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

{
  "search": "revenue",
  "filter": "(Type eq 'Report' or Type eq 'SemanticModel') and WorkspaceId eq '7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3'",
  "pageSize": 2
}

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": "c41d9f2e-7b60-4a15-8d3c-2f6e9a0b7c48",
      "type": "SemanticModel",
      "catalogEntryType": "FabricItem",
      "displayName": "Revenue Semantic Model",
      "description": "Shared revenue model backing the sales reports.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    }
  ],
  "continuationToken": "eyJza2lwIjoyLCJ0YWtl..."
}

Definicje

Nazwisko 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.
ErrorParameter

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
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

Reprezentacja metadanych wykazu elementu Fabric.
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.
WorkspaceCatalogEntry

Reprezentacja metadanych wykazu w obszarze roboczym Fabric.
WorkspaceCatalogEntryType

Typ zgłoszony we wpisie wykazu obszarów roboczych. Dodatkowe typy WorkspaceCatalogEntryType 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.
Workspace

Typ wpisu wykazu obszarów roboczych.

CatalogQueryRequest

Objekt

Zapytanie dotyczące wyszukiwania.

Nazwisko Typ Opis
continuationToken

string

Token kontynuacji następnej strony.

Token kontynuacji przekazuje element search, filteri pageSize oryginalnego żądania, więc może zostać wysłany samodzielnie. Nie może być połączony z tym samym żądaniem search lub filter w tym samym żądaniu; w ten sposób zwracany jest błąd.
filter

string

Filtr wyszukiwania. W miarę upływu czasu można dodać dodatkowe opcje filtru.

Parametr filtru obsługuje następujące właściwości:

  • Typ: pasuje do type właściwości wpisu wykazu, na przykład Report, Lakehouselub Workspace. Pojedynczy filtr może określać maksymalnie 500 wartości typu, z których każdy ma długość do 50 znaków.

  • WorkspaceId: identyfikator obszaru roboczego, który zawiera wpis wykazu. Jeden filtr może określać co najwyżej 12 wartości WorkspaceId, z których każdy musi być prawidłowym identyfikatorem GUID.

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ść.

  • and: Logical AND; pasuje tylko wtedy, gdy wszystkie warunki są spełnione.

  • 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. Wartość domyślna to 50.
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.

Pole wyszukiwania obsługuje następujące operatory:

  • " " : Podwójne cudzysłowy; dopasuj ujęte wyrazy jako dokładną frazę.

  • * : gwiazdka; symbol wieloznaczny odpowiadający zero lub więcej znaków.

  • ? : Znak zapytania; symbol wieloznaczny pasujący do pojedynczego znaku.

  • &: Double ampersands; wymaga każdego terminu wyszukiwania.

  • Podkreślenia są traktowane jako część terminu wyszukiwania; nie jest wymagane żadne ucieczki.

  • Inne znaki specjalne są ignorowane i traktowane jako separatory.

CatalogQueryResponse

Objekt

Wyniki wyszukiwania.

Nazwisko Typ Opis
continuationToken

string

Element continuationToken dla następnej strony.
value CatalogEntry[]:

Lista wpisów wykazu

CatalogWorkspace

Objekt

Obszar roboczy wpisu wykazu.

Nazwisko Typ Opis
displayName

string

Nazwa wyświetlana obszaru roboczego.
id

string (uuid)

Identyfikator obszaru roboczego.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko Typ Opis
message

string

Czytelny dla człowieka opis znaczenia parametru.
name

string

Identyfikator parametru.
value

string

Wartość parametru.

ErrorRelatedResource

Objekt

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

Nazwisko 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.

Nazwisko 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.
parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
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.

Nazwisko 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.
parameters

ErrorParameter[]

Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

ItemCatalogEntry

Objekt

Reprezentacja metadanych wykazu elementu Fabric.

Nazwisko 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.

Nazwisko 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.
PolicySet

Zestaw zasad.
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.
Monitoring

Element monitorowania.
DeploymentPlan

Plan wdrożenia.
ShareSubscription

Subskrypcja udziału.
Share

Udział.

WorkspaceCatalogEntry

Objekt

Reprezentacja metadanych wykazu w obszarze roboczym Fabric.

Nazwisko Typ Opis
catalogEntryType string:

Workspace

Typ wpisu wykazu.
description

string

Opis wpisu wykazu.
displayName

string

Nazwa wyświetlana wpisu wykazu.
id

string (uuid)

ObjectId wpisu wykazu.
type

WorkspaceCatalogEntryType

Typ wpisu wykazu. Zawsze Workspace w przypadku wpisów wykazu obszarów roboczych.

WorkspaceCatalogEntryType

Wyliczenie

Typ zgłoszony we wpisie wykazu obszarów roboczych. Dodatkowe typy WorkspaceCatalogEntryType można dodawać w czasie.

Wartość Opis
Workspace

Obszar roboczy.