Catalog - Search

บริการ:: Core

เวอร์ชัน API:: v1

API การค้นหาแค็ตตาล็อกช่วยให้สามารถค้นหารายการแค็ตตาล็อก OneLake ทางโปรแกรมทั่วทั้งพื้นที่ทํางานได้ สนับสนุนการค้นหาข้ามพื้นที่ทํางานบนเมตาดาต้าของแค็ตตาล็อกและแสดงผลลัพธ์ที่กรองไปยังรายการหลักที่เรียกได้รับอนุญาตให้เข้าถึง ผลลัพธ์การค้นหาประกอบด้วยตัวระบุที่เสถียรซึ่งมีวัตถุประสงค์เพื่อใช้กับ Api Fabric เพิ่มเติมเพื่อดึงรายละเอียดเพิ่มเติมหรือดําเนินการที่ได้รับการสนับสนุน

Note

ขณะนี้การค้นหาแค็ตตาล็อกอยู่ในตัวอย่าง (เรียนรู้เพิ่มเติม)

แค็ตตาล็อกเอนทิตีเป็นการแสดงเมตาดาต้าที่ค้นพบได้ของเอนทิตี Microsoft Fabric ซึ่งครอบคลุมรายการพื้นที่ทํางานในขณะนี้ รายการแค็ตตาล็อกมีไว้สําหรับการค้นหาเมตาดาต้าเท่านั้นและไม่อนุญาตให้เข้าถึงข้อมูลพื้นฐานหรือเนื้อหารายการ

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

Catalog.Read.All

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

Identity	การสนับสนุน
ผู้ใช้	ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	ใช่

ข้อจำกัด

ฟังก์ชันการค้นหาจะถูกกําหนดขอบเขตสําหรับชนิดรายการ Fabric ที่เฉพาะเจาะจงในขณะนี้ ประเภทรายการต่อไปนี้ไม่ได้รับการสนับสนุน: แดชบอร์ด, กระแสข้อมูล (Gen1), กระแสข้อมูล (Gen2)

ส่วนติดต่อ

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

เนื้อความของคำขอ

ชื่อ	พิมพ์	คำอธิบาย
continuationToken	string	continuationToken สําหรับหน้าถัดไป
filter	string	ตัวกรองสําหรับการค้นหา ในขณะนี้ ตัวกรองสนับสนุนตัวกรองตามชนิดของรายการ ตัวเลือกตัวกรองเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป พารามิเตอร์ตัวกรองสนับสนุนตัวดําเนินการต่อไปนี้เพื่อปรับปรุงผลลัพธ์: eq : เท่ากับ; จับคู่ค่าที่แน่นอน ne : ไม่เท่ากับ; ไม่รวมค่าที่ระบุ หรือ : ตรรกะ OR จับคู่ ถ้าเงื่อนไขใดๆ เป็นจริง ( ) : วงเล็บ; ( นิพจน์ กลุ่ม เพื่อกําหนดลําดับชั้นเชิงตรรกะ
pageSize	integer	ขนาดหน้าที่จําเป็นต้องส่งกลับ ขนาดหน้าต้องอยู่ระหว่าง 1 ถึง 1000
search	string	คิวรีข้อความสําหรับการค้นหา เขตข้อมูลนี้สนับสนุนการค้นหาชื่อที่แสดง ชื่อที่แสดงของพื้นที่ทํางาน และคําอธิบายของ CatalogEntry

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย

200 OK

ชื่อ	พิมพ์	คำอธิบาย
200 OK	CatalogQueryResponse	ตกลง
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	continuationToken สําหรับหน้าถัดไป
filter	string	ตัวกรองสําหรับการค้นหา ในขณะนี้ ตัวกรองสนับสนุนตัวกรองตามชนิดของรายการ ตัวเลือกตัวกรองเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป พารามิเตอร์ตัวกรองสนับสนุนตัวดําเนินการต่อไปนี้เพื่อปรับปรุงผลลัพธ์: eq : เท่ากับ; จับคู่ค่าที่แน่นอน ne : ไม่เท่ากับ; ไม่รวมค่าที่ระบุ หรือ : ตรรกะ OR จับคู่ ถ้าเงื่อนไขใดๆ เป็นจริง ( ) : วงเล็บ; ( นิพจน์ กลุ่ม เพื่อกําหนดลําดับชั้นเชิงตรรกะ
pageSize	integer	ขนาดหน้าที่จําเป็นต้องส่งกลับ ขนาดหน้าต้องอยู่ระหว่าง 1 ถึง 1000
search	string	คิวรีข้อความสําหรับการค้นหา เขตข้อมูลนี้สนับสนุนการค้นหาชื่อที่แสดง ชื่อที่แสดงของพื้นที่ทํางาน และคําอธิบายของ CatalogEntry

CatalogQueryResponse

วัตถุ

ผลลัพธ์ของการค้นหา

ชื่อ	พิมพ์	คำอธิบาย
continuationToken	string	continuationToken สําหรับหน้าถัดไป
value	CatalogEntry[]: ItemCatalogEntry[]	รายการของรายการแค็ตตาล็อก

CatalogWorkspace

วัตถุ

พื้นที่ทํางานสําหรับรายการแค็ตตาล็อก

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อที่แสดงของพื้นที่ทํางาน
id	string (uuid)	ID ของพื้นที่ทํางาน

ErrorRelatedResource

วัตถุ

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

การตอบสนองข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable	boolean	เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง `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	เมาท์ DataFactory
SQLDatabase	SQLDatabase
CopyJob	งานคัดลอก
VariableLibrary	VariableLibrary
Dataflow	กระแสข้อมูล
ApacheAirflowJob	ApacheAirflowJob
WarehouseSnapshot	สแนปช็อตของคลังสินค้า
DigitalTwinBuilder	DigitalTwinBuilder
DigitalTwinBuilderFlow	โฟลว์ Digital Twin Builder
MirroredAzureDatabricksCatalog	แค็ตตาล็อก azure databricks ที่มิเรอร์
Map	แผนที่.
AnomalyDetector	การตรวจหาความผิดปกติ
UserDataFunction	ฟังก์ชันข้อมูลผู้ใช้
GraphModel	GraphModel
GraphQuerySet	ชุดคิวรีกราฟ
SnowflakeDatabase	ฐานข้อมูล Snowflake เพื่อจัดเก็บตาราง Iceberg ที่สร้างขึ้นจากบัญชี Snowflake
OperationsAgent	OperationsAgent
CosmosDBDatabase	ฐานข้อมูล Cosmos DB
Ontology	โทโพโลยี
EventSchemaSet	EventSchemaSet
DataAgent	DataAgent
MirroredCatalog	มิเรอร์ดคาตาล็อก