Поделиться через

Items - Refresh Sql Endpoint Metadata

Служба:
SQLEndpoint
Версия API:
v1

Замечание

Этот API предварительной версии является экспериментальным и может изменяться без уведомления. Он предоставляется только для оценки и разработки; Не рекомендуется использовать рабочую среду.

Обновляет все таблицы в конечной точке аналитики SQL.
Этот API поддерживает длительные операции (LRO).

Разрешения

Вызывающий объект должен иметь участника или более поздней роли рабочей области.

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

Item.ReadWrite.All

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

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

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

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/refreshMetadata?preview={preview}

Параметры URI

Имя В Обязательно Тип Описание
sqlEndpointId
 path True

string (uuid)

Идентификатор конечной точки аналитики SQL.
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.
preview
 query True

boolean

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

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

Имя Тип Описание
timeout

Duration

Длительность запроса до истечения времени ожидания. Значение по умолчанию — 15 минут.

Ответы

Имя Тип Описание
200 OK

TableSyncStatus[]

Запрос успешно завершен.
202 Accepted

Запрос принят, обновление таблицы аналитики SQL выполняется.

Заголовки

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • ItemNotFound — запрошенный элемент не найден.

Примеры

Refresh all tables for a specified SQL analytics endpoint in a workspace

Образец запроса

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/refreshMetadata?preview=true

Пример ответа

Код состояния:
200 
[
  {
    "tableName": "Table 1",
    "startDateTime": "2025-02-04T22:29:12.4400865Z",
    "endDateTime": "2025-02-04T22:29:12.4869641Z",
    "status": "Success",
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  },
  {
    "tableName": "Table 2",
    "startDateTime": "2025-02-04T22:29:13.4400865Z",
    "endDateTime": "2025-02-04T22:29:13.4869641Z",
    "status": "Failure",
    "error": {
      "errorCode": "AdalRetryException",
      "message": "Couldn't run query. There is a problem with the Microsoft Entra ID token. Have the warehouse owner log in again. If they're unavailable, use the takeover feature."
    },
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  },
  {
    "tableName": "Table 3",
    "startDateTime": "2025-02-04T22:29:14.4400865Z",
    "endDateTime": "2025-02-04T22:29:14.4869641Z",
    "status": "NotRun",
    "lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
  }
]

Определения

Имя Описание
Duration

Длительность.
ErrorRelatedResource

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

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

Сведения об ответе на ошибку.
SqlEndpointRefreshMetadataRequest

Обновите полезные данные запроса конечных точек sql analaytics.
SyncStatus

Состояние операции синхронизации. С течением времени могут добавляться дополнительные типы SyncStatus.
TableSyncStatus

Объект состояния синхронизации таблиц.
TimeUnit

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

Duration

Object

Длительность.

Имя Тип Описание
timeUnit

TimeUnit

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

number

Количество единиц времени в течение длительности.

ErrorRelatedResource

Object

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

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

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

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

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

SqlEndpointRefreshMetadataRequest

Object

Обновите полезные данные запроса конечных точек sql analaytics.

Имя Тип Описание
timeout

Duration

Длительность запроса до истечения времени ожидания. Значение по умолчанию — 15 минут.

SyncStatus

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

Состояние операции синхронизации. С течением времени могут добавляться дополнительные типы SyncStatus.

Значение Описание
Failure

Указывает на сбой.
NotRun

Указывает, что операция не выполнялась.
Success

Указывает на успешное выполнение.

TableSyncStatus

Object

Объект состояния синхронизации таблиц.

Имя Тип Описание
endDateTime

string (date-time)

Дата и время завершения синхронизации таблиц в формате UTC с использованием формата YYYY-MM-DDTHH:mm:ssZ.
error

ErrorResponseDetails

Сведения об ответе на ошибку
lastSuccessfulSyncDateTime

string (date-time)

Дата и время успешной синхронизации таблиц в формате UTC с использованием формата YYYY-MM-DDTHH:mm:ssZ.
startDateTime

string (date-time)

Дата и время начала синхронизации таблиц в формате UTC с использованием формата ГГГГ-ММ-ДДTHH:mm:ssZ.
status

SyncStatus

Синхронизирована ли таблица без ошибок.
tableName

string

Имя таблицы, синхронизированной.

TimeUnit

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

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

Значение Описание
Days

Длительность в днях.
Hours

Длительность в часах.
Minutes

Длительность в минутах.
Seconds

Длительность в секундах.