Catalog - Search
API การค้นหาแค็ตตาล็อกช่วยให้สามารถค้นหารายการแค็ตตาล็อก OneLake ทางโปรแกรมทั่วทั้งพื้นที่ทํางานได้ สนับสนุนการค้นหาข้ามพื้นที่ทํางานบนเมตาดาต้าของแค็ตตาล็อกและแสดงผลลัพธ์ที่กรองไปยังรายการหลักที่เรียกได้รับอนุญาตให้เข้าถึง ผลลัพธ์การค้นหาประกอบด้วยตัวระบุที่เสถียรซึ่งมีวัตถุประสงค์เพื่อใช้กับ Api Fabric เพิ่มเติมเพื่อดึงรายละเอียดเพิ่มเติมหรือดําเนินการที่ได้รับการสนับสนุน
Note
ขณะนี้การค้นหาแค็ตตาล็อกอยู่ในตัวอย่าง (เรียนรู้เพิ่มเติม)
แค็ตตาล็อกเอนทิตีเป็นการแสดงเมตาดาต้าที่ค้นพบได้ของเอนทิตี Microsoft Fabric ซึ่งครอบคลุมรายการพื้นที่ทํางานในขณะนี้ รายการแค็ตตาล็อกมีไว้สําหรับการค้นหาเมตาดาต้าเท่านั้นและไม่อนุญาตให้เข้าถึงข้อมูลพื้นฐานหรือเนื้อหารายการ
การอนุญาต
ผู้เรียกสามารถค้นหารายการแค็ตตาล็อกสําหรับพื้นที่ทํางานและรายการที่ผู้เรียกได้รับอนุญาตให้เข้าถึงเท่านั้น
จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์
Catalog.Read.All
ข้อจำกัด
continuationTokenต้องไม่รวมกับsearchหรือfilterโทเค็นนําค่าเหล่านั้นมาจากคําขอต้นทางแล้วpageSizeต้องอยู่ระหว่าง 1 ถึง 1000
ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra
API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้
| Identity | การสนับสนุน |
|---|---|
| ผู้ใช้ | ใช่ |
| บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ | ใช่ |
ส่วนติดต่อ
POST https://api.fabric.microsoft.com/v1/catalog/search
เนื้อความของคำขอ
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| continuationToken |
string |
โทเค็นความต่อเนื่องสําหรับหน้าถัดไป โทเค็นความต่อเนื่องจะดําเนินการไปข้างหน้า |
| filter |
string |
ตัวกรองสําหรับการค้นหา ตัวเลือกตัวกรองเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป พารามิเตอร์ตัวกรองสนับสนุนคุณสมบัติต่อไปนี้:
พารามิเตอร์ตัวกรองสนับสนุนตัวดําเนินการต่อไปนี้เพื่อปรับปรุงผลลัพธ์:
|
| pageSize |
integer |
ขนาดหน้าที่จําเป็นต้องส่งกลับ ขนาดหน้าต้องอยู่ระหว่าง 1 ถึง 1000 ค่าเริ่มต้นคือ 50 |
| search |
string |
คิวรีข้อความสําหรับการค้นหา เขตข้อมูลนี้สนับสนุนการค้นหาชื่อที่แสดง ชื่อที่แสดงของพื้นที่ทํางาน และคําอธิบายของ CatalogEntry เขตข้อมูลการค้นหาสนับสนุนตัวดําเนินการต่อไปนี้:
|
การตอบสนอง
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| 200 OK |
ตกลง |
|
| 429 Too Many Requests |
เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ ส่วนหัว Retry-After: integer |
|
| Other Status Codes |
รหัสข้อผิดพลาดทั่วไป:
|
ตัวอย่าง
| Search example |
| Search within a workspace example |
Search example
คำขอตัวอย่าง
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'"
}
คำตอบตัวอย่าง
{
"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
คำขอตัวอย่าง
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
}
คำตอบตัวอย่าง
{
"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..."
}
คำจำกัดความ
| ชื่อ | คำอธิบาย |
|---|---|
|
Catalog |
ชนิดรายการแค็ตตาล็อก ประเภท |
|
Catalog |
คิวรีสําหรับการค้นหา |
|
Catalog |
ผลลัพธ์ของการค้นหา |
|
Catalog |
พื้นที่ทํางานสําหรับรายการแค็ตตาล็อก |
|
Error |
พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด |
|
Error |
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
Error |
การตอบสนองข้อผิดพลาด |
|
Error |
รายละเอียดการตอบสนองข้อผิดพลาด |
|
Item |
การแสดงเมตาดาต้าแค็ตตาล็อกของรายการ Fabric |
|
Item |
บรรพบุรุษของรายการในสถาปัตยกรรมข้อมูลของ Fabric จะส่งคืนเฉพาะระดับที่ใช้ได้เท่านั้น |
|
Item |
ชนิดของสินค้า คุณสามารถเพิ่มชนิดหน่วยข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป |
|
Workspace |
การแสดงเมตาดาต้าแค็ตตาล็อกของพื้นที่ทํางาน Fabric |
|
Workspace |
ชนิดที่รายงานบนรายการแค็ตตาล็อกพื้นที่ทํางาน ประเภท |
CatalogEntryType
ชนิดรายการแค็ตตาล็อก ประเภท CatalogEntryType เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
| ค่า | คำอธิบาย |
|---|---|
| FabricItem |
ชนิดรายการแค็ตตาล็อกรายการ Fabric |
| Workspace |
ชนิดรายการแค็ตตาล็อกของพื้นที่ทํางาน |
CatalogQueryRequest
คิวรีสําหรับการค้นหา
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| continuationToken |
string |
โทเค็นความต่อเนื่องสําหรับหน้าถัดไป โทเค็นความต่อเนื่องจะดําเนินการไปข้างหน้า |
| filter |
string |
ตัวกรองสําหรับการค้นหา ตัวเลือกตัวกรองเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป พารามิเตอร์ตัวกรองสนับสนุนคุณสมบัติต่อไปนี้:
พารามิเตอร์ตัวกรองสนับสนุนตัวดําเนินการต่อไปนี้เพื่อปรับปรุงผลลัพธ์:
|
| pageSize |
integer |
ขนาดหน้าที่จําเป็นต้องส่งกลับ ขนาดหน้าต้องอยู่ระหว่าง 1 ถึง 1000 ค่าเริ่มต้นคือ 50 |
| search |
string |
คิวรีข้อความสําหรับการค้นหา เขตข้อมูลนี้สนับสนุนการค้นหาชื่อที่แสดง ชื่อที่แสดงของพื้นที่ทํางาน และคําอธิบายของ CatalogEntry เขตข้อมูลการค้นหาสนับสนุนตัวดําเนินการต่อไปนี้:
|
CatalogQueryResponse
ผลลัพธ์ของการค้นหา
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| continuationToken |
string |
continuationToken สําหรับหน้าถัดไป |
| value | CatalogEntry[]: |
รายการของรายการแค็ตตาล็อก |
CatalogWorkspace
พื้นที่ทํางานสําหรับรายการแค็ตตาล็อก
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| displayName |
string |
ชื่อที่แสดงของพื้นที่ทํางาน |
| id |
string (uuid) |
ID ของพื้นที่ทํางาน |
ErrorParameter
พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| message |
string |
คําอธิบายที่มนุษย์สามารถอ่านได้ของความหมายของพารามิเตอร์ |
| name |
string |
ตัวระบุพารามิเตอร์ |
| value |
string |
ค่าพารามิเตอร์ |
ErrorRelatedResource
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| resourceId |
string |
ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
| resourceType |
string |
ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponse
การตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| isRetriable |
boolean |
เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| moreDetails |
รายการรายละเอียดข้อผิดพลาดเพิ่มเติม |
|
| parameters |
พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด |
|
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
| requestId |
string (uuid) |
รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponseDetails
รายละเอียดการตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| parameters |
พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด |
|
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
ItemCatalogEntry
การแสดงเมตาดาต้าแค็ตตาล็อกของรายการ Fabric
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| catalogEntryType |
string:
Fabric |
ชนิดรายการแค็ตตาล็อก |
| description |
string |
คําอธิบายของรายการแค็ตตาล็อก |
| displayName |
string |
ชื่อที่แสดงของรายการแค็ตตาล็อก |
| hierarchy |
ลําดับชั้นของรายการแค็ตตาล็อก |
|
| id |
string (uuid) |
objectId ของรายการแค็ตตาล็อก |
| type |
ชนิดรายการ Fabric |
ItemCatalogEntryHierarchy
บรรพบุรุษของรายการในสถาปัตยกรรมข้อมูลของ Fabric จะส่งคืนเฉพาะระดับที่ใช้ได้เท่านั้น
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| workspace |
พื้นที่ทํางานที่มีรายการ |
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 |
มิเรอร์ดคาตาล็อก |
| PolicySet |
ชุดนโยบาย |
| AppBackend |
AppBackend |
| OrgApp |
แอปองค์กร |
| OrgAppAudience |
ผู้ชมแอปองค์กร |
| DataBuildToolJob |
DataBuildToolJob |
| AzureDatabricksStorage |
รายการพื้นที่จัดเก็บข้อมูลที่สํารองข้อมูลโดย OneLake สําหรับ Azure Databricks |
| Plan |
แผนน่ะ |
| Monitoring |
รายการการตรวจสอบ |
| DeploymentPlan |
แผนการปรับใช้งาน |
WorkspaceCatalogEntry
การแสดงเมตาดาต้าแค็ตตาล็อกของพื้นที่ทํางาน Fabric
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| catalogEntryType |
string:
Workspace |
ชนิดรายการแค็ตตาล็อก |
| description |
string |
คําอธิบายของรายการแค็ตตาล็อก |
| displayName |
string |
ชื่อที่แสดงของรายการแค็ตตาล็อก |
| id |
string (uuid) |
objectId ของรายการแค็ตตาล็อก |
| type |
ชนิดรายการแค็ตตาล็อก สําหรับรายการแค็ตตาล็อกของพื้นที่ทํางานเสมอ |
WorkspaceCatalogEntryType
ชนิดที่รายงานบนรายการแค็ตตาล็อกพื้นที่ทํางาน ประเภท WorkspaceCatalogEntryType เพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
| ค่า | คำอธิบาย |
|---|---|
| Workspace |
พื้นที่ทํางาน |