Catalog - Search

Layanan:

Core

Versi API:

v1

API Pencarian Katalog memungkinkan penemuan terprogram entri katalog OneLake di seluruh ruang kerja. Ini mendukung pencarian lintas ruang kerja melalui metadata katalog dan mengembalikan hasil yang difilter untuk entri prinsipal panggilan diotorisasi untuk diakses. Hasil pencarian mencakup pengidentifikasi stabil yang dimaksudkan untuk digunakan dengan API Fabric pelengkap untuk mengambil detail tambahan atau melakukan tindakan yang didukung.

Nota

Pencarian katalog saat ini dalam Pratinjau (pelajari lebih lanjut).

CatalogEntry adalah representasi metadata yang dapat ditemukan dari entitas Microsoft Fabric, yang saat ini dilingkup ke item ruang kerja. Entri katalog hanya ditujukan untuk penemuan metadata dan tidak memberikan akses ke konten data atau item yang mendasar.

Permissions

Pemanggil hanya dapat menemukan entri katalog untuk ruang kerja dan item yang diizinkan untuk diakses oleh pemanggil.

Cakupan Didelegasikan yang Diperlukan

Catalog.Read.All

Keterbatasan

• continuationToken tidak boleh digabungkan dengan search atau filter. Token sudah membawa nilai-nilai tersebut dari permintaan asal.

• pageSize harus antara 1 dan 1000.

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Support
Pengguna	Yes
Prinsipal Layanan dan Identitas Terkelola	Yes

Antarmuka

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

Isi Permintaan

Nama	Jenis	Deskripsi
continuationToken	string	Token kelanjutan untuk halaman berikutnya. Token kelanjutan membawa ke depan search, filter, dan pageSize permintaan asli, sehingga dapat dikirim sendiri. Ini tidak boleh dikombinasikan dengan search atau filter dalam permintaan yang sama; melakukannya mengembalikan kesalahan.
filter	string	Filter untuk pencarian. Opsi filter tambahan dapat ditambahkan dari waktu ke waktu. Parameter filter mendukung properti berikut: Jenis: Cocok dengan type properti entri katalog, misalnya Report, , Lakehouseatau Workspace. Satu filter dapat menentukan paling banyak 500 nilai Jenis, masing-masing hingga 50 karakter. WorkspaceId: ID ruang kerja yang berisi entri katalog. Satu filter dapat menentukan paling banyak 12 nilai WorkspaceId, yang masing-masing harus merupakan GUID yang valid. Parameter filter mendukung operator berikut untuk menyempurnakan hasil: eq: Sama dengan; cocok dengan nilai yang tepat. ne: Tidak Sama dengan; mengecualikan nilai yang ditentukan. dan: Logis DAN; cocok hanya jika semua kondisi benar. atau: Logis ATAU; cocok jika salah satu kondisinya benar. ( ): Tanda kurung; mengelompokkan ekspresi untuk menentukan hierarki logis.
pageSize	integer	Ukuran halaman yang perlu dikembalikan. Ukuran halaman harus antara 1 dan 1000. Secara default ke 50.
search	string	Kueri teks untuk pencarian. Bidang ini mendukung pencarian di seluruh nama tampilan, nama tampilan ruang kerja, dan deskripsi CatalogEntry. Bidang pencarian mendukung operator berikut: " : Tanda kutip ganda; cocokkan kata-kata yang diapit sebagai frasa yang tepat. * : Tanda bintang; kartubebas yang cocok dengan nol karakter atau lebih. ? : Tanda tanya; kartubebas yang cocok dengan satu karakter. && : Dua kali lipat; memerlukan setiap istilah pencarian. Garis bawah diperlakukan sebagai bagian dari istilah pencarian; tidak diperlukan pelepasan. Karakter khusus lainnya diabaikan dan diperlakukan sebagai pemisah.

Respons

Nama	Jenis	Deskripsi
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header Retry-After yang menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: InvalidRequest - Isi permintaan tidak disediakan, atau tidak valid. InvalidSearch - Nilai search tidak dapat diurai. InvalidFilter - Tidak filter dapat diurai, atau nilai filter salah bentuk atau melebihi panjang maksimumnya. InvalidFilterProperty - Mereferensikan filter properti yang tidak didukung. FilterTooManyValues - Menentukan lebih banyak nilai untuk properti daripada yang diizinkan properti tersebut filter . FilterNotSupported - Pemfilteran tidak didukung. ConflictingFilterParameters - continuationToken dikombinasikan dengan search atau filter. InvalidPageSize - pageSize berada di luar rentang 1 hingga 1000. InvalidContinuationToken - continuationToken Tidak valid. ContinuationTokenTooLong - Melebihi continuationToken panjang maksimum. TypeNotFound - Mereferensikan filter tipe item yang tidak ada. Tidak sah - Autentikasi hilang atau tidak valid Kesalahan Server Internal - Kegagalan layanan tak terduga.

Contoh

Search example

Search within a workspace example

Search example

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

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

Permintaan sampel

HTTP

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
}

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
CatalogEntryType	Jenis entri katalog. Jenis CatalogEntryType tambahan dapat ditambahkan dari waktu ke waktu.
CatalogQueryRequest	Kueri untuk pencarian.
CatalogQueryResponse	Hasil pencarian.
CatalogWorkspace	Ruang kerja untuk entri katalog.
ErrorParameter	Parameter terstruktur yang menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Rincian respons kesalahan.
ItemCatalogEntry	Representasi metadata katalog dari item Fabric.
ItemCatalogEntryHierarchy	Nenek moyang langsung item dalam arsitektur data Fabric. Hanya tingkat yang berlaku yang dikembalikan.
ItemType	Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.
WorkspaceCatalogEntry	Representasi metadata katalog dari ruang kerja Fabric.
WorkspaceCatalogEntryType	Jenis yang dilaporkan pada entri katalog ruang kerja. Jenis WorkspaceCatalogEntryType tambahan dapat ditambahkan dari waktu ke waktu.

CatalogEntryType

Enumerasi

Jenis entri katalog. Jenis CatalogEntryType tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
FabricItem	Jenis entri katalog item Fabric.
Workspace	Jenis entri katalog ruang kerja.

CatalogQueryRequest

Objek

Kueri untuk pencarian.

Nama	Jenis	Deskripsi
continuationToken	string	Token kelanjutan untuk halaman berikutnya. Token kelanjutan membawa ke depan search, filter, dan pageSize permintaan asli, sehingga dapat dikirim sendiri. Ini tidak boleh dikombinasikan dengan search atau filter dalam permintaan yang sama; melakukannya mengembalikan kesalahan.
filter	string	Filter untuk pencarian. Opsi filter tambahan dapat ditambahkan dari waktu ke waktu. Parameter filter mendukung properti berikut: Jenis: Cocok dengan type properti entri katalog, misalnya Report, , Lakehouseatau Workspace. Satu filter dapat menentukan paling banyak 500 nilai Jenis, masing-masing hingga 50 karakter. WorkspaceId: ID ruang kerja yang berisi entri katalog. Satu filter dapat menentukan paling banyak 12 nilai WorkspaceId, yang masing-masing harus merupakan GUID yang valid. Parameter filter mendukung operator berikut untuk menyempurnakan hasil: eq: Sama dengan; cocok dengan nilai yang tepat. ne: Tidak Sama dengan; mengecualikan nilai yang ditentukan. dan: Logis DAN; cocok hanya jika semua kondisi benar. atau: Logis ATAU; cocok jika salah satu kondisinya benar. ( ): Tanda kurung; mengelompokkan ekspresi untuk menentukan hierarki logis.
pageSize	integer	Ukuran halaman yang perlu dikembalikan. Ukuran halaman harus antara 1 dan 1000. Secara default ke 50.
search	string	Kueri teks untuk pencarian. Bidang ini mendukung pencarian di seluruh nama tampilan, nama tampilan ruang kerja, dan deskripsi CatalogEntry. Bidang pencarian mendukung operator berikut: " : Tanda kutip ganda; cocokkan kata-kata yang diapit sebagai frasa yang tepat. * : Tanda bintang; kartubebas yang cocok dengan nol karakter atau lebih. ? : Tanda tanya; kartubebas yang cocok dengan satu karakter. && : Dua kali lipat; memerlukan setiap istilah pencarian. Garis bawah diperlakukan sebagai bagian dari istilah pencarian; tidak diperlukan pelepasan. Karakter khusus lainnya diabaikan dan diperlakukan sebagai pemisah.

CatalogQueryResponse

Objek

Hasil pencarian.

Nama	Jenis	Deskripsi
continuationToken	string	ContinuationToken untuk halaman berikutnya.
value	CatalogEntry[]: ItemCatalogEntry[] WorkspaceCatalogEntry[]	Daftar entri katalog

CatalogWorkspace

Objek

Ruang kerja untuk entri katalog.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan ruang kerja.
id	string (uuid)	Identitas ruang kerja.

ErrorParameter

Objek

Parameter terstruktur yang menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.

Nama	Jenis	Deskripsi
message	string	Deskripsi yang dapat dibaca manusia tentang arti parameter.
name	string	Pengidentifikasi parameter.
value	string	Nilai parameter.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
isRetriable	boolean	Jika benar, permintaan dapat dicoba kembali. Retry-After Gunakan header respons untuk menentukan penundaan, jika tersedia.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
parameters	ErrorParameter[]	Parameter terstruktur menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
relatedResource	ErrorRelatedResource	Detail dari sumber daya yang terkait dengan kesalahan.
requestId	string (uuid)	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Rincian respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
parameters	ErrorParameter[]	Parameter terstruktur menyediakan konteks tambahan yang dapat dibaca mesin tentang kesalahan.
relatedResource	ErrorRelatedResource	Detail dari sumber daya yang terkait dengan kesalahan.

ItemCatalogEntry

Objek

Representasi metadata katalog dari item Fabric.

Nama	Jenis	Deskripsi
catalogEntryType	string: FabricItem	Jenis entri katalog.
description	string	Deskripsi entri katalog.
displayName	string	Nama tampilan entri katalog.
hierarchy	ItemCatalogEntryHierarchy	Hierarki entri katalog.
id	string (uuid)	ObjectId entri katalog.
type	ItemType	Jenis item Fabric.

ItemCatalogEntryHierarchy

Objek

Nenek moyang langsung item dalam arsitektur data Fabric. Hanya tingkat yang berlaku yang dikembalikan.

Nama	Jenis	Deskripsi
workspace	CatalogWorkspace	Ruang kerja yang berisi item.

ItemType

Enumerasi

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Dashboard	Dasbor PowerBI.
Report	Laporan PowerBI.
SemanticModel	Model semantik PowerBI.
PaginatedReport	Laporan paginasi PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Sebuah lakehouse.
Eventhouse	Sebuah rumah acara.
Environment	Lingkungan.
KQLDatabase	Database KQL.
KQLQueryset	Set kueri KQL.
KQLDashboard	Dasbor KQL.
DataPipeline	Alur data.
Notebook	Buku catatan.
SparkJobDefinition	Definisi pekerjaan spark.
MLExperiment	Eksperimen pembelajaran mesin.
MLModel	Model pembelajaran mesin.
Warehouse	Sebuah gudang.
Eventstream	Sebuah aliran peristiwa.
SQLEndpoint	Titik akhir SQL.
MirroredWarehouse	Sebuah gudang cermin.
MirroredDatabase	Database cermin.
Reflex	Sebuah Refleks.
GraphQLApi	API untuk item GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Sebuah SQLDatabase.
CopyJob	Pekerjaan Penyalinan.
VariableLibrary	VariabelLibrary.
Dataflow	Aliran Data.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Rekam jepret gudang.
DigitalTwinBuilder	Sebuah DigitalTwinBuilder.
DigitalTwinBuilderFlow	Alur Pembangun Kembar Digital.
MirroredAzureDatabricksCatalog	Katalog azure databricks cermin.
Map	Peta.
AnomalyDetector	Detektor Anomali.
UserDataFunction	Fungsi data pengguna.
GraphModel	Sebuah GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake Database untuk menyimpan tabel Iceberg yang dibuat dari akun Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Database Cosmos DB.
Ontology	Ontologi.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.
PolicySet	Set Kebijakan.
AppBackend	An AppBackend.
OrgApp	Aplikasi Org.
OrgAppAudience	Audiens Aplikasi Org.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	Item penyimpanan yang didukung OneLake untuk Azure Databricks.
Plan	Sebuah rencana.
Monitoring	Item Pemantauan.
DeploymentPlan	Rencana penyebaran.

WorkspaceCatalogEntry

Objek

Representasi metadata katalog dari ruang kerja Fabric.

Nama	Jenis	Deskripsi
catalogEntryType	string: Workspace	Jenis entri katalog.
description	string	Deskripsi entri katalog.
displayName	string	Nama tampilan entri katalog.
id	string (uuid)	ObjectId entri katalog.
type	WorkspaceCatalogEntryType	Jenis entri katalog. Selalu Workspace untuk entri katalog ruang kerja.

WorkspaceCatalogEntryType

Enumerasi

Jenis yang dilaporkan pada entri katalog ruang kerja. Jenis WorkspaceCatalogEntryType tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Workspace	Ruang kerja.