Items - Refresh Sql Endpoint Metadata

Usługa:
SQLEndpoint
Wersja interfejsu API:
v1

Odświeża tabele w punkcie końcowym analizy SQL.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Jeśli tables element jest podany w treści żądania, odświeżane są tylko określone tabele. Po pominięciu lub opróżnieniu wszystkie tabele są odświeżane.

Permissions

Obiekt wywołujący musi mieć rolę współautora lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

Item.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interface

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
sqlEndpointId
 path True

string (uuid)

Identyfikator punktu końcowego analizy SQL.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.

Treść żądania

Nazwa Typ Opis
recreateTables

boolean

Po ustawieniu wartości true ta właściwość nakazuje systemowi usunięcie i ponowne utworzenie wszystkich tabel w punkcie końcowym analizy SQL podczas procesu odświeżania. Użyj tej opcji, jeśli chcesz w pełni skompilować tabele z ich definicji źródłowych, na przykład, aby rozwiązać niespójności lub zapewnić czyste odświeżanie. W połączeniu z tablesprogramem resetowanie stanu synchronizacji jest ograniczone tylko do określonych tabel. Wartość domyślna to fałsz.
tables

TableDefinition[]

Po podaniu zakresy odświeżania są ograniczone tylko do wymienionych tabel. Po pominięciu lub opróżnieniu wszystkie tabele są odświeżane. Każdy wpis określa schemat i co najmniej jedną nazwę tabeli do odświeżenia w tym schemacie. Maksymalna liczba tabel, które można zsynchronizować w jednym żądaniu, wynosi 25. Rozpoznawanie tabel zależy od tego, czy element nadrzędny punktu końcowego SQL jest włączony w schemacie. W przypadku elementów z obsługą schematu tabele są rozpoznawane przy użyciu schematu dostarczonego przez obiekt wywołujący. W przypadku elementów bez obsługi schematu wszystkie tabele są rozpoznawane w domyślnym schemacie niezależnie od wartości schematu dostarczonej przez obiekt wywołujący; Tabele w schemacie nie domyślnym nie mogą zostać rozwiązane i zostaną zgłoszone z powodu błędu DeltaTableNotFound .
timeout

Duration

Czas trwania żądania przed upływem limitu czasu. Wartość domyślna to 15 minut.

Odpowiedzi

Nazwa Typ Opis
200 OK

TableSyncStatuses

Żądanie zostało ukończone pomyślnie.
202 Accepted

Żądanie zaakceptowane, trwa odświeżanie tabeli sql analytics.

Nagłówki

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • ItemNotFound — żądany element nie został znaleziony.

Przykłady

Refresh all tables for a specified SQL analytics endpoint in a workspace
Refresh selective tables for a specified SQL analytics endpoint in a workspace
Refresh selective tables with recreate tables for a specified SQL analytics endpoint in a workspace
Refresh selective tables with user defined schemas for a specified SQL analytics endpoint in a workspace

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "value": [
    {
      "tableName": "Table 1",
      "startDateTime": "2025-08-08T10:31:22.2708973Z",
      "endDateTime": "2025-08-08T10:36:54.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2025-08-08T10:36:54.9651741Z"
    },
    {
      "tableName": "Table 2",
      "startDateTime": "2025-08-08T10:31:22.2708973Z",
      "endDateTime": "2025-08-08T10:43:02.5329616Z",
      "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": "2025-08-07T10:44:27.2632648Z"
    },
    {
      "tableName": "Table 3",
      "startDateTime": "2025-08-08T10:31:22.2708973Z",
      "endDateTime": "2025-08-08T10:36:59.9183509Z",
      "status": "NotRun",
      "lastSuccessfulSyncDateTime": "2025-08-06T08:32:53.3890146Z"
    }
  ]
}

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

Przykładowe żądanie

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

{
  "tables": [
    {
      "schema": "dbo",
      "tableNames": [
        "Orders",
        "OrderDetails"
      ]
    },
    {
      "schema": "dbo",
      "tableNames": [
        "DailySummary"
      ]
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "value": [
    {
      "tableName": "Orders",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:25.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
    },
    {
      "tableName": "OrderDetails",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:26.5329616Z",
      "status": "Failure",
      "error": {
        "errorCode": "DeltaTableNotFound",
        "message": "Delta table 'Tables\\OrderDetails\\_delta_log' not found."
      },
      "lastSuccessfulSyncDateTime": "2026-06-08T10:31:26.5329616Z"
    },
    {
      "tableName": "DailySummary",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:24.9183509Z",
      "status": "NotRun",
      "lastSuccessfulSyncDateTime": "2026-06-08T08:32:53.3890146Z"
    }
  ]
}

Refresh selective tables with recreate tables for a specified SQL analytics endpoint in a workspace

Przykładowe żądanie

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

{
  "recreateTables": true,
  "tables": [
    {
      "schema": "dbo",
      "tableNames": [
        "Orders",
        "OrderDetails"
      ]
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "value": [
    {
      "tableName": "Orders",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:25.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
    },
    {
      "tableName": "OrderDetails",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:26.5329616Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:26.5329616Z"
    }
  ]
}

Refresh selective tables with user defined schemas for a specified SQL analytics endpoint in a workspace

Przykładowe żądanie

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

{
  "tables": [
    {
      "schema": "sales",
      "tableNames": [
        "Orders",
        "OrderDetails"
      ]
    },
    {
      "schema": "analytics",
      "tableNames": [
        "DailySummary"
      ]
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "value": [
    {
      "tableName": "sales.Orders",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:25.9651741Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:25.9651741Z"
    },
    {
      "tableName": "sales.OrderDetails",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:26.5329616Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:26.5329616Z"
    },
    {
      "tableName": "analytics.DailySummary",
      "startDateTime": "2026-06-09T14:31:22.2708973Z",
      "endDateTime": "2026-06-09T14:31:24.9183509Z",
      "status": "Success",
      "lastSuccessfulSyncDateTime": "2026-06-09T14:31:24.9183509Z"
    }
  ]
}

Definicje

Nazwa Opis
Duration

Czas trwania.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
SqlEndpointRefreshMetadataRequest

Ładunek żądania na potrzeby odświeżania punktu końcowego analizy SQL.
SyncStatus

Stan operacji synchronizacji. Dodatkowe typy SyncStatus można dodawać w czasie.
TableDefinition

Para nazw schematów i tabel do określania zakresu odświeżania selektywnego.
TableSyncStatus

Obiekt stanu synchronizacji tabeli.
TableSyncStatuses

Lista stanów synchronizacji tabel.
TimeUnit

Jednostka czasu na czas trwania. Dodatkowe typy czasu trwania mogą być dodawane w czasie.

Duration

Objekt

Czas trwania.

Nazwa Typ Opis
timeUnit

TimeUnit

Jednostka czasu na czas trwania. Dodatkowe typy czasu trwania mogą być dodawane w czasie.
value

number

Liczba elementów timeUnits w czasie trwania.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable

boolean

Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string (uuid)

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

SqlEndpointRefreshMetadataRequest

Objekt

Ładunek żądania na potrzeby odświeżania punktu końcowego analizy SQL.

Nazwa Typ Opis
recreateTables

boolean

Po ustawieniu wartości true ta właściwość nakazuje systemowi usunięcie i ponowne utworzenie wszystkich tabel w punkcie końcowym analizy SQL podczas procesu odświeżania. Użyj tej opcji, jeśli chcesz w pełni skompilować tabele z ich definicji źródłowych, na przykład, aby rozwiązać niespójności lub zapewnić czyste odświeżanie. W połączeniu z tablesprogramem resetowanie stanu synchronizacji jest ograniczone tylko do określonych tabel. Wartość domyślna to fałsz.
tables

TableDefinition[]

Po podaniu zakresy odświeżania są ograniczone tylko do wymienionych tabel. Po pominięciu lub opróżnieniu wszystkie tabele są odświeżane. Każdy wpis określa schemat i co najmniej jedną nazwę tabeli do odświeżenia w tym schemacie. Maksymalna liczba tabel, które można zsynchronizować w jednym żądaniu, wynosi 25. Rozpoznawanie tabel zależy od tego, czy element nadrzędny punktu końcowego SQL jest włączony w schemacie. W przypadku elementów z obsługą schematu tabele są rozpoznawane przy użyciu schematu dostarczonego przez obiekt wywołujący. W przypadku elementów bez obsługi schematu wszystkie tabele są rozpoznawane w domyślnym schemacie niezależnie od wartości schematu dostarczonej przez obiekt wywołujący; Tabele w schemacie nie domyślnym nie mogą zostać rozwiązane i zostaną zgłoszone z powodu błędu DeltaTableNotFound .
timeout

Duration

Czas trwania żądania przed upływem limitu czasu. Wartość domyślna to 15 minut.

SyncStatus

Wyliczenie

Stan operacji synchronizacji. Dodatkowe typy SyncStatus można dodawać w czasie.

Wartość Opis
Success

Wskazuje powodzenie.
Failure

Wskazuje błąd.
NotRun

Wskazuje, że operacja nie została uruchomiona.

TableDefinition

Objekt

Para nazw schematów i tabel do określania zakresu odświeżania selektywnego.

Nazwa Typ Opis
schema

string

minLength: 1
maxLength: 128

Nazwa schematu dla rozpoznawania tabel. Nie może być zarezerwowanym schematem systemu.
tableNames

string[]

minLength: 1
maxLength: 128

Co najmniej jedna nazwa tabeli do odświeżenia w określonym schemacie.

TableSyncStatus

Objekt

Obiekt stanu synchronizacji tabeli.

Nazwa Typ Opis
endDateTime

string (date-time)

Data i godzina zakończenia synchronizacji tabeli w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
error

ErrorResponseDetails

Szczegóły odpowiedzi na błąd
lastSuccessfulSyncDateTime

string (date-time)

Data i godzina pomyślnej synchronizacji tabeli w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
startDateTime

string (date-time)

Data i godzina rozpoczęcia synchronizacji tabeli w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
status

SyncStatus

Określa, czy tabela została zsynchronizowana bez błędów.
tableName

string

Nazwa zsynchronizowanej tabeli. W przypadku elementów z obsługą schematu nazwa tabeli jest poprzedzona nazwą schematu (np. "schema.tableName").

TableSyncStatuses

Objekt

Lista stanów synchronizacji tabel.

Nazwa Typ Opis
value

TableSyncStatus[]

Lista stanów synchronizacji tabel.

TimeUnit

Wyliczenie

Jednostka czasu na czas trwania. Dodatkowe typy czasu trwania mogą być dodawane w czasie.

Wartość Opis
Seconds

Czas trwania w sekundach.
Minutes

Czas trwania w minutach.
Hours

Czas trwania w godzinach.
Days

Czas trwania w dniach.