Discovery - Discover Schemas

Usługa:

MirroredAzureDatabricksCatalog

Wersja interfejsu API:

v1

Uwaga / Notatka

Ten interfejs API jest w wersji zapoznawczej.

Zwraca listę schematów w danym wykazie z wykazu aparatu Unity.
Ten interfejs API obsługuje stronicowanie.

Uprawnienia

Obiekt wywołujący musi mieć lub większą rolę obszaru roboczego.

Wymagane zakresy delegowane

Workspace.Read.All lub Workspace.ReadWrite.All lub DatabricksCatalog.Read.All

Tożsamości obsługiwane przez Microsoft Entra

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

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Nie.

Interfejs

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/azuredatabricks/catalogs/{catalogName}/schemas?databricksWorkspaceConnectionId={databricksWorkspaceConnectionId}

Z parametrami opcjonalnymi:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/azuredatabricks/catalogs/{catalogName}/schemas?databricksWorkspaceConnectionId={databricksWorkspaceConnectionId}&continuationToken={continuationToken}&maxResults={maxResults}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
catalogName	path	True	string	Nazwa wykazu.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
databricksWorkspaceConnectionId	query	True	string (uuid)	Identyfikator połączenia obszaru roboczego usługi Databricks.
continuationToken	query		string	Token do pobierania następnej strony wyników.
maxResults	query		integer	Maksymalna liczba wyników do zwrócenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DatabricksSchemas	Żądanie zostało ukończone pomyślnie.
Other Status Codes	ErrorResponse	Typowe kody błędów: OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu. CorruptedPayload — podany ładunek jest uszkodzony.

Przykłady

List Databricks schemas example

Przykładowe żądanie

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/azuredatabricks/catalogs/catalog_1/schemas?databricksWorkspaceConnectionId=c1128f28-d84f-417c-8234-0feb91e35f86

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "name": "schema_1",
      "fullName": "catalog_1.schema_1",
      "storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/schemas/230217cd-94f2-4017-907d-768298b02e2b"
    },
    {
      "name": "schema_2",
      "fullName": "catalog_1.schema_2"
    }
  ],
  "continuationToken": null,
  "continuationUri": null
}

Definicje

Nazwa	Opis
DatabricksSchema	Schemat z wykazu aparatu Unity
DatabricksSchemas	Lista schematów z wykazu aparatu Unity.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.

DatabricksSchema

Objekt

Schemat z wykazu aparatu Unity

Nazwa	Typ	Opis
fullName	string	Pełna nazwa schematu w postaci catalog_name.schema_name.
name	string	Nazwa schematu względem katalogu nadrzędnego.
storageLocation	string	Lokalizacja magazynu schematu.

DatabricksSchemas

Objekt

Lista schematów z wykazu aparatu Unity.

Nazwa	Typ	Opis
Error	ErrorResponse	Błąd jest ustawiony, jeśli nie można pobrać schematów
continuationToken	string	Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
continuationUri	string	Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
value	DatabricksSchema[]	Lista schematów usługi Databricks.

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