Catalog - Search

서비스:
Core
API 버전:
v1

카탈로그 검색 API를 사용하면 작업 영역에서 OneLake 카탈로그 항목을 프로그래밍 방식으로 검색할 수 있습니다. 카탈로그 메타데이터에 대한 작업 영역 간 검색을 지원하고 호출 주체가 액세스할 수 있는 권한이 있는 항목으로 필터링된 결과를 반환합니다. 검색 결과에는 추가 세부 정보를 검색하거나 지원되는 작업을 수행하기 위해 보완 패브릭 API와 함께 사용하려는 안정적인 식별자가 포함됩니다.

메모

카탈로그 검색은 현재 미리 보기로 제공됩니다(자세한 정보).

CatalogEntry는 현재 작업 영역 항목으로 범위가 지정된 Microsoft Fabric 엔터티의 검색 가능한 메타데이터 표현입니다. 카탈로그 항목은 메타데이터 검색 전용이며 기본 데이터 또는 항목 콘텐츠에 대한 액세스 권한을 부여하지 않습니다.

필요한 위임된 범위

Catalog.Read.All

Microsoft Entra 지원 식별자

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

정체성 지원
사용자 예
서비스 주체 및 관리 ID 예

제한점

  • 검색 기능은 현재 특정 패브릭 항목 유형으로 범위가 지정됩니다. 대시보드, 데이터 흐름(Gen1), 데이터 흐름(Gen2) 항목 유형은 지원되지 않습니다.

인터페이스

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

요청 본문

Name 형식 Description
continuationToken

string

다음 페이지의 continuationToken입니다.
filter

string

검색에 대한 필터입니다. 현재 필터는 항목 유형별로 필터를 지원합니다. 시간이 지남에 따라 추가 필터 옵션을 추가할 수 있습니다.

필터 매개 변수는 결과를 구체화하기 위해 다음 연산자를 지원합니다.

  • eq: Equals; 는 정확한 값과 일치합니다.

  • ne: 같지 않음; 는 지정된 값을 제외합니다.

  • 또는 : 논리적 OR; 조건이 true이면 일치합니다.

  • ( ) : 괄호; 논리 계층을 정의하기 위해 식을 그룹화합니다.
pageSize

integer

반환해야 하는 페이지 크기입니다. 페이지 크기는 1에서 1000 사이여야 합니다.
search

string

검색에 대한 텍스트 쿼리입니다. 이 필드는 표시 이름, 작업 영역 표시 이름 및 CatalogEntry에 대한 설명을 검색할 수 있습니다.

응답

Name 형식 Description
200 OK

CatalogQueryResponse

그래
429 Too Many Requests

ErrorResponse

서비스 속도 제한을 초과했습니다. 서버는 클라이언트가 Retry-After 추가 요청을 보내기 전에 대기해야 하는 시간을 초 단위로 나타내는 헤더를 반환합니다.

헤더

Retry-After: integer
Other Status Codes

ErrorResponse

일반적인 오류 코드:

  • 권한 없음 - 누락되거나 잘못된 인증

  • 내부 서버 오류 - 예기치 않은 서비스 오류입니다.

예제

Search example

샘플 요청

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

정의

Name Description
CatalogEntryType

카탈로그 항목 유형입니다. 추가 CatalogEntryType 형식은 시간이 지남에 따라 추가될 수 있습니다.
CatalogQueryRequest

검색에 대한 쿼리입니다.
CatalogQueryResponse

검색의 결과입니다.
CatalogWorkspace

카탈로그 항목의 작업 영역입니다.
ErrorRelatedResource

오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse

오류 응답입니다.
ErrorResponseDetails

오류 응답 세부 정보입니다.
ItemCatalogEntry

카탈로그 항목의 패브릭 항목 유형입니다.
ItemCatalogEntryHierarchy

Fabric 데이터 아키텍처에 있는 항목의 직설 상위 항목입니다. 적용 가능한 수준만 반환됩니다.
ItemType

항목의 유형입니다. 추가 항목 유형은 시간이 지남에 따라 추가될 수 있습니다.

CatalogEntryType

열거형

카탈로그 항목 유형입니다. 추가 CatalogEntryType 형식은 시간이 지남에 따라 추가될 수 있습니다.

값 Description
FabricItem

패브릭 항목 카탈로그 항목 유형입니다.

CatalogQueryRequest

Object

검색에 대한 쿼리입니다.

Name 형식 Description
continuationToken

string

다음 페이지의 continuationToken입니다.
filter

string

검색에 대한 필터입니다. 현재 필터는 항목 유형별로 필터를 지원합니다. 시간이 지남에 따라 추가 필터 옵션을 추가할 수 있습니다.

필터 매개 변수는 결과를 구체화하기 위해 다음 연산자를 지원합니다.

  • eq: Equals; 는 정확한 값과 일치합니다.

  • ne: 같지 않음; 는 지정된 값을 제외합니다.

  • 또는 : 논리적 OR; 조건이 true이면 일치합니다.

  • ( ) : 괄호; 논리 계층을 정의하기 위해 식을 그룹화합니다.
pageSize

integer

반환해야 하는 페이지 크기입니다. 페이지 크기는 1에서 1000 사이여야 합니다.
search

string

검색에 대한 텍스트 쿼리입니다. 이 필드는 표시 이름, 작업 영역 표시 이름 및 CatalogEntry에 대한 설명을 검색할 수 있습니다.

CatalogQueryResponse

Object

검색의 결과입니다.

Name 형식 Description
continuationToken

string

다음 페이지의 continuationToken입니다.
value CatalogEntry[]:

ItemCatalogEntry[]

카탈로그 항목 목록

CatalogWorkspace

Object

카탈로그 항목의 작업 영역입니다.

Name 형식 Description
displayName

string

작업 영역의 표시 이름입니다.
id

string (uuid)

작업 영역의 ID입니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name 형식 Description
resourceId

string

오류와 관련된 리소스 ID입니다.
resourceType

string

오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
isRetriable

boolean

true이면 요청을 다시 시도 할 수 있습니다. 응답 헤더를 Retry-After 사용하여 가능한 경우 지연을 확인합니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
moreDetails

ErrorResponseDetails[]

추가 오류 세부 정보 목록입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.
requestId

string (uuid)

오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.

ItemCatalogEntry

Object

카탈로그 항목의 패브릭 항목 유형입니다.

Name 형식 Description
catalogEntryType string:

FabricItem

카탈로그 항목 유형입니다.
description

string

카탈로그 항목에 대한 설명입니다.
displayName

string

카탈로그 항목 표시 이름입니다.
hierarchy

ItemCatalogEntryHierarchy

카탈로그 항목의 계층 구조입니다.
id

string (uuid)

카탈로그 항목의 objectId입니다.
type

ItemType

패브릭 항목 유형입니다.

ItemCatalogEntryHierarchy

Object

Fabric 데이터 아키텍처에 있는 항목의 직설 상위 항목입니다. 적용 가능한 수준만 반환됩니다.

Name 형식 Description
workspace

CatalogWorkspace

항목이 포함된 작업 영역입니다.

ItemType

열거형

항목의 유형입니다. 추가 항목 유형은 시간이 지남에 따라 추가될 수 있습니다.

값 Description
Dashboard

PowerBI 대시보드.
Report

PowerBI 보고서입니다.
SemanticModel

PowerBI 의미 체계 모델입니다.
PaginatedReport

PowerBI 페이지를 매긴 보고서입니다.
Datamart

PowerBI datamart.
Lakehouse

레이크 하우스.
Eventhouse

이벤트 하우스.
Environment

환경입니다.
KQLDatabase

KQL 데이터베이스입니다.
KQLQueryset

KQL 쿼리 세트입니다.
KQLDashboard

KQL 대시보드.
DataPipeline

데이터 파이프라인입니다.
Notebook

공책.
SparkJobDefinition

Spark 작업 정의입니다.
MLExperiment

기계 학습 실험입니다.
MLModel

기계 학습 모델입니다.
Warehouse

창고.
Eventstream

이벤트스트림입니다.
SQLEndpoint

SQL 엔드포인트입니다.
MirroredWarehouse

미러된 창고입니다.
MirroredDatabase

미러된 데이터베이스입니다.
Reflex

반사.
GraphQLApi

GraphQL 항목에 대한 API입니다.
MountedDataFactory

MountedDataFactory입니다.
SQLDatabase

SQLDatabase입니다.
CopyJob

복사 작업입니다.
VariableLibrary

VariableLibrary입니다.
Dataflow

데이터 흐름입니다.
ApacheAirflowJob

ApacheAirflowJob입니다.
WarehouseSnapshot

웨어하우스 스냅샷.
DigitalTwinBuilder

DigitalTwinBuilder입니다.
DigitalTwinBuilderFlow

디지털 트윈 빌더 흐름입니다.
MirroredAzureDatabricksCatalog

미러된 Azure Databricks 카탈로그입니다.
Map

지도입니다.
AnomalyDetector

Anomaly Detector입니다.
UserDataFunction

사용자 데이터 함수입니다.
GraphModel

GraphModel입니다.
GraphQuerySet

Graph QuerySet입니다.
SnowflakeDatabase

Snowflake 계정에서 만든 빙산 테이블을 저장하는 Snowflake 데이터베이스입니다.
OperationsAgent

OperationsAgent입니다.
CosmosDBDatabase

Cosmos DB 데이터베이스입니다.
Ontology

온톨로지입니다.
EventSchemaSet

EventSchemaSet입니다.
DataAgent

DataAgent입니다.
MirroredCatalog

MirroredCatalog입니다.