Udostępnij przez

Items - Get Data Pipeline Definition

Usługa:
DataPipeline
Wersja interfejsu API:
v1

Zwraca określoną definicję publiczną potoku danych.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Gdy uzyskasz publiczną definicję elementu DataPipeline, etykieta poufności nie jest częścią definicji.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla potoku danych.

Wymagane zakresy delegowane

DataPipeline.ReadWrite.All lub Item.ReadWrite.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 Tak

Interfejs

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition
Z parametrami opcjonalnymi: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition?format={format}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
dataPipelineId
 path True

string (uuid)

Identyfikator potoku danych.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.
format
 query

string

Format definicji publicznej potoku danych.

Odpowiedzi

Nazwa Typ Opis
200 OK

DataPipelineDefinitionResponse

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

Zaakceptowano żądanie. Pobieranie definicji jest w toku.

Nagłówki

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

ErrorResponse

Typowe kody błędów:

  • OperationNotSupportedForItem — operacja nieobsługiwana dla żądanego elementu.

Przykłady

Get a data pipeline public definition example

Przykładowe żądanie

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/dataPipelines/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Przykładowa odpowiedź

Kod stanu:
200 
{
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Kod stanu:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definicje

Nazwa Opis
DataPipelineDefinition

Obiekt definicji publicznej potoku danych.
DataPipelineDefinitionPart

Obiekt części definicji potoku danych.
DataPipelineDefinitionResponse

Odpowiedź na publiczną definicję potoku danych.
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

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

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

DataPipelineDefinition

Objekt

Obiekt definicji publicznej potoku danych.

Nazwa Typ Opis
format

string

Format definicji elementu.
parts

DataPipelineDefinitionPart[]

Lista części definicji.

DataPipelineDefinitionPart

Objekt

Obiekt części definicji potoku danych.

Nazwa Typ Opis
path

string

Ścieżka części potoku danych.
payload

string

Ładunek częściowy potoku danych.
payloadType

PayloadType

Typ ładunku.

DataPipelineDefinitionResponse

Objekt

Odpowiedź na publiczną definicję potoku danych.

Nazwa Typ Opis
definition

DataPipelineDefinition

Obiekt definicji publicznej potoku danych.

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.

PayloadType

Wyliczanie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość Opis
InlineBase64

Śródliniowa baza 64.