Udostępnij przez

Background Jobs - Run On Demand Execute

Usługa:
Dataflow
Wersja interfejsu API:
v1

Uruchom wystąpienie zadania wykonywania na żądanie.

Note

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego. Adres URL tego interfejsu API został zaktualizowany w celu uwzględnienia typu zadania w ramach ścieżki, zastępując poprzednie użycie parametru zapytania. W przypadku zgodności z poprzednimi wersjami wywołania używające parametru zapytania są nadal obsługiwane.

Wymagane zakresy delegowane

W przypadku interfejsów API przepływów danych użyj następujących typów zakresów:

  • Określony zakres: Dataflow.Execute.All

Aby uzyskać więcej informacji na temat zakresów, zobacz artykuł: zakresy.

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 No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/Execute/instances

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
dataflowId
 path True

string (uuid)

Identyfikator przepływu danych.
workspaceId
 path True

string (uuid)

Identyfikator przestrzeni roboczej.

Treść żądania

Nazwa Typ Opis
executionData

DataflowExecutionPayload

Payload for run on-demand execute job request .Payload for run on-demand execute job request (Ładunek dla uruchamiania żądania wykonania zadania na żądanie). Wymagane tylko wtedy, gdy przepływ danych ma włączoną parametryzacja.

Odpowiedzi

Nazwa Typ Opis
202 Accepted

Żądanie zaakceptowane, wykonywanie zadania jest w toku.

Nagłówki

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • InsufficientPrivileges — obiekt wywołujący nie ma wystarczających uprawnień do uruchamiania wystąpienia zadania.

  • InvalidJobType — żądany typ zadania jest nieprawidłowy.

  • TooManyRequestsForJobs — obiekt wywołujący żąda zbyt wielu żądań zadań na żądanie.

  • ItemNotFound — nie znaleziono żądanego identyfikatora elementu.

Przykłady

Run dataflow Execute job instance with no request body example
Run dataflow Execute job instance with request body containing parameters example

Run dataflow Execute job instance with no request body example

Przykładowe żądanie

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances

Przykładowa odpowiedź

Kod stanu:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

Run dataflow Execute job instance with request body containing parameters example

Przykładowe żądanie

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances

{
  "executionData": {
    "executeOption": "ApplyChangesIfNeeded",
    "parameters": [
      {
        "parameterName": "OrderKey",
        "type": "Automatic",
        "value": 25
      },
      {
        "parameterName": "Threshold",
        "type": "Automatic",
        "value": "start"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

Definicje

Nazwa Opis
DataflowExecutionPayload

Ładunek danych wykonywania dla przepływu danych
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

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

Opcje uruchamiania operacji wykonywania. W miarę upływu czasu można dodać dodatkowe polecenia executeOptions.
ItemJobParameter

Szczegóły parametru.
RunOnDemandDataflowExecuteJobRequest

Uruchamianie na żądanie— wykonywanie ładunku wystąpienia zadania przepływu danych
Type

Typ parametru. Dodatkowe typy parametrów można dodawać w czasie.

DataflowExecutionPayload

Objekt

Ładunek danych wykonywania dla przepływu danych

Nazwa Typ Opis
executeOption

ExecuteOption

Opcje uruchamiania operacji wykonywania. W miarę upływu czasu można dodać dodatkowe polecenia executeOptions.
parameters

ItemJobParameter[]

Lista parametrów do zastąpienia podczas wykonywania.

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.

ExecuteOption

Wyliczenie

Opcje uruchamiania operacji wykonywania. W miarę upływu czasu można dodać dodatkowe polecenia executeOptions.

Wartość Opis
SkipApplyChanges

Wartość domyślna. Operacja Zastosuj zmiany została pominięta.
ApplyChangesIfNeeded

Operacja Appply Changes jest wykonywana w razie potrzeby. Może być używany, gdy do wykonania są wymagane najnowsze zmiany.

ItemJobParameter

Objekt

Szczegóły parametru.

Nazwa Typ Opis
parameterName

string

Nazwa parametru.
type

Type

Typ parametru. Dodatkowe typy parametrów można dodawać w czasie.
value

Wartość parametru do zastąpienia podczas wykonywania.

RunOnDemandDataflowExecuteJobRequest

Objekt

Uruchamianie na żądanie— wykonywanie ładunku wystąpienia zadania przepływu danych

Nazwa Typ Opis
executionData

DataflowExecutionPayload

Payload for run on-demand execute job request .Payload for run on-demand execute job request (Ładunek dla uruchamiania żądania wykonania zadania na żądanie). Wymagane tylko wtedy, gdy przepływ danych ma włączoną parametryzacja.

Type

Wyliczenie

Typ parametru. Dodatkowe typy parametrów można dodawać w czasie.

Wartość Opis
Automatic

Wartość musi być automatyczna