Catalog - Search

Служба:: Core

Версия API:: v1

API поиска по каталогу обеспечивает программное обнаружение записей каталога OneLake в рабочих областях. Он поддерживает поиск между рабочими областями по метаданным каталога и возвращает результаты, отфильтрованные для записей вызывающего субъекта, авторизован для доступа. Результаты поиска включают стабильные идентификаторы, которые предназначены для использования с дополнительными API Fabric для получения дополнительных сведений или выполнения поддерживаемых действий.

Замечание

Поиск по каталогу в настоящее время находится в предварительной версии (подробнее).

CatalogEntry — это обнаруживаемое представление метаданных сущности Microsoft Fabric, которое в настоящее время распространяется на элементы рабочей области. Записи каталога предназначены только для обнаружения метаданных и не предоставляют доступ к базовым данным или содержимому элемента.

Обязательные делегированные области доступа

Catalog.Read.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
User	Да
Представитель службы и управляемые удостоверения	Да

Ограничения

Функции поиска в настоящее время относятся к определенным типам элементов Fabric. Следующие типы элементов не поддерживаются: панель мониторинга, поток данных (1-го поколения), поток данных (2-го поколения).

Интерфейс

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

Текст запроса

Имя	Тип	Описание
continuationToken	string	ПродолжениеToken для следующей страницы.
filter	string	Фильтр для поиска. В настоящее время фильтр поддерживает фильтрацию по типам записей. С течением времени могут добавляться дополнительные параметры фильтра. Параметр фильтра поддерживает следующие операторы для уточнения результатов: eq: Equals; соответствует точному значению. ne: Not Equals; исключает указанное значение. или : логическое ИЛИ; соответствует, если одно из условий имеет значение true. ( ) : круглые скобки; группирует выражения для определения логической иерархии.
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."
    },
    {
      "id": "123d697c-7848-77cd-b887-91bfb12347cc",
      "type": "Lakehouse",
      "catalogEntryType": "FabricItem",
      "displayName": "Yeartly Sales Revenue",
      "description": "Consolidated revenue report for the current fiscal year."
    }
  ],
  "continuationToken": "lyJ1257lksfdfG=="
}

Определения

Имя	Описание
CatalogEntryType	Тип записи каталога. С течением времени могут добавляться дополнительные `CatalogEntryType` типы.
CatalogQueryRequest	Запрос для поиска.
CatalogQueryResponse	Результаты поиска.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ItemCatalogEntry	Тип элемента Fabric записи каталога.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

CatalogEntryType

Перечисление

Тип записи каталога. С течением времени могут добавляться дополнительные CatalogEntryType типы.

Значение	Описание
FabricItem	Тип записи каталога элементов Fabric.

CatalogQueryRequest

Объект

Запрос для поиска.

Имя	Тип	Описание
continuationToken	string	ПродолжениеToken для следующей страницы.
filter	string	Фильтр для поиска. В настоящее время фильтр поддерживает фильтрацию по типам записей. С течением времени могут добавляться дополнительные параметры фильтра. Параметр фильтра поддерживает следующие операторы для уточнения результатов: eq: Equals; соответствует точному значению. ne: Not Equals; исключает указанное значение. или : логическое ИЛИ; соответствует, если одно из условий имеет значение true. ( ) : круглые скобки; группирует выражения для определения логической иерархии.
pageSize	integer	Размер страницы, который необходимо вернуть. Размер страницы должен быть от 1 до 1000.
search	string	Текстовый запрос для поиска. Это поле поддерживает поиск по отображаемого имени и описанию CatalogEntry.

CatalogQueryResponse

Объект

Результаты поиска.

Имя	Тип	Описание
continuationToken	string	ПродолжениеToken для следующей страницы.
value	CatalogEntry[]: ItemCatalogEntry[]	Список записей каталога

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
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	Отображаемое имя записи каталога.
id	string (uuid)	ObjectId записи каталога.
type	ItemType	Тип элемента Fabric.

ItemType

Перечисление

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

Значение	Описание
Dashboard	Панель мониторинга PowerBI.
Report	Отчет PowerBI.
SemanticModel	Семантическая модель PowerBI.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Озеро.
Eventhouse	Хранилище событий.
Environment	Среда.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
KQLDashboard	Панель мониторинга KQL.
DataPipeline	Конвейер данных.
Notebook	Записная книжка.
SparkJobDefinition	Определение задания Spark.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
Warehouse	Склад.
Eventstream	Поток событий.
SQLEndpoint	Конечная точка SQL.
MirroredWarehouse	Зеркальный склад.
MirroredDatabase	Зеркальная база данных.
Reflex	Рефлекс.
GraphQLApi	API для элемента GraphQL.
MountedDataFactory	ПодключеннаяdataFactory.
SQLDatabase	База данных SQLDatabase.
CopyJob	Задание копирования.
VariableLibrary	ПеременнаяLibrary.
Dataflow	Поток данных.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Моментальный снимок хранилища.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Поток Конструктора цифровых двойников.
MirroredAzureDatabricksCatalog	Зеркальный каталог azure databricks.
Map	Карта.
AnomalyDetector	Детектор аномалий.
UserDataFunction	Функция данных пользователя.
GraphModel	A GraphModel.
GraphQuerySet	Набор запросов Graph.
SnowflakeDatabase	База данных Snowflake для хранения таблиц Iceberg, созданных из учетной записи Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	База данных Cosmos DB.
Ontology	An Ontology.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	ЗеркальныйCatalog.