Catalog - Search

Tjänst:: Core

API-version:: v1

API:et för katalogsökning möjliggör programmatisk identifiering av OneLake-katalogposter mellan arbetsytor. Den stöder sökning mellan arbetsytor över katalogmetadata och returnerar resultat filtrerade till poster som anropande huvudnamn har behörighet att komma åt. Sökresultaten innehåller stabila identifierare som är avsedda att användas med kompletterande Infrastruktur-API:er för att hämta ytterligare information eller utföra åtgärder som stöds.

Anmärkning

Katalogsökning är för närvarande i förhandsversion (läs mer).

En CatalogEntry är en identifierbar metadatarepresentation av en Microsoft Fabric-entitet som för närvarande är begränsad till arbetsyteobjekt. Katalogposter är endast avsedda för metadataidentifiering och beviljar inte åtkomst till underliggande data eller objektinnehåll.

Obligatoriska delegerade omfång

Catalog.Read.All

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Support
User	Ja
Tjänsthuvudnamn och hanterade identiteter	Ja

Begränsningar

Sökfunktionen är för närvarande begränsad till specifika typer av infrastrukturobjekt. Följande objekttyper stöds inte: Instrumentpanel, Dataflöde (Gen1), Dataflöde (Gen2).

Gränssnitt

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

Begärandetext

Name	Typ	Description
continuationToken	string	continuationToken för nästa sida.
filter	string	Filtret för sökningen. För närvarande stöder filtret filter efter typ av poster. Ytterligare filteralternativ kan läggas till över tid. Filterparametern stöder följande operatorer för att förfina resultaten: eq : Lika med; matchar det exakta värdet. ne : Inte lika med; exkluderar det angivna värdet. eller : Logisk OR; matchar om något av villkoren är sant. ( ) : Parenteser; grupperar uttryck för att definiera logisk hierarki.
pageSize	integer	Sidstorleken som måste returneras. Sidstorleken måste vara mellan 1 och 1 000.
search	string	Textfrågan för sökningen. Det här fältet stöder sökning i visningsnamnet, arbetsytans visningsnamn och beskrivning av CatalogEntry.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: Obehörig – autentisering saknas eller är ogiltig Internt serverfel – Oväntat tjänstfel.

CatalogQueryResponse

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

Obehörig – autentisering saknas eller är ogiltig
Internt serverfel – Oväntat tjänstfel.

Exempel

Search example

Exempelbegäran

HTTP

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

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

Exempelsvar

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

Definitioner

Name	Description
CatalogEntryType	Posttypen katalog. Ytterligare `CatalogEntryType` typer kan läggas till över tid.
CatalogQueryRequest	Frågan för sökningen.
CatalogQueryResponse	Resultatet av sökningen.
CatalogWorkspace	Arbetsytan för katalogposten.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Detaljer om felsvaret.
ItemCatalogEntry	En typ av katalogpost för infrastrukturobjekt.
ItemCatalogEntryHierarchy	Objektets omedelbara överordnade objekt i Fabric dataarkitektur. Endast tillämpliga nivåer returneras.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

CatalogEntryType

Uppräkning

Posttypen katalog. Ytterligare CatalogEntryType typer kan läggas till över tid.

Värde	Description
FabricItem	En posttyp för katalog för infrastrukturobjekt.

CatalogQueryRequest

Objekt

Frågan för sökningen.

Name	Typ	Description
continuationToken	string	continuationToken för nästa sida.
filter	string	Filtret för sökningen. För närvarande stöder filtret filter efter typ av poster. Ytterligare filteralternativ kan läggas till över tid. Filterparametern stöder följande operatorer för att förfina resultaten: eq : Lika med; matchar det exakta värdet. ne : Inte lika med; exkluderar det angivna värdet. eller : Logisk OR; matchar om något av villkoren är sant. ( ) : Parenteser; grupperar uttryck för att definiera logisk hierarki.
pageSize	integer	Sidstorleken som måste returneras. Sidstorleken måste vara mellan 1 och 1 000.
search	string	Textfrågan för sökningen. Det här fältet stöder sökning i visningsnamnet, arbetsytans visningsnamn och beskrivning av CatalogEntry.

CatalogQueryResponse

Objekt

Resultatet av sökningen.

Name	Typ	Description
continuationToken	string	continuationToken för nästa sida.
value	CatalogEntry[]: ItemCatalogEntry[]	En lista över katalogposter

CatalogWorkspace

Objekt

Arbetsytan för katalogposten.

Name	Typ	Description
displayName	string	Arbetsytans visningsnamn.
id	string (uuid)	Arbetsområdets ID.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Resurs-ID:t som är inblandat i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Detaljer om felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Detaljer om resursen relaterad till felet.

ItemCatalogEntry

Objekt

En typ av katalogpost för infrastrukturobjekt.

Name	Typ	Description
catalogEntryType	string: FabricItem	Posttypen katalog.
description	string	Beskrivningen av katalogposten.
displayName	string	Visningsnamnet för katalogposten.
hierarchy	ItemCatalogEntryHierarchy	Hierarkin för katalogposten.
id	string (uuid)	ObjectId för katalogposten.
type	ItemType	Typ av infrastrukturobjekt.

ItemCatalogEntryHierarchy

Objekt

Objektets omedelbara överordnade objekt i Fabric dataarkitektur. Endast tillämpliga nivåer returneras.

Name	Typ	Description
workspace	CatalogWorkspace	Arbetsytan som innehåller objektet.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En anteckningsbok.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaSet.
DataAgent	En DataAgent.
MirroredCatalog	En MirroredCatalog.