Partilhar via

Background Jobs - Run On Demand Execute

Serviço:
Dataflow
Versão da API:
v1

Executar instância de trabalho de execução sob demanda.

Note

Esta API faz parte de uma versão de pré-visualização e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base no feedback e não é recomendado para uso em produção. O URL desta API foi atualizado para incluir o tipo de trabalho como parte do caminho, substituindo o uso anterior de um parâmetro de consulta. Para compatibilidade retroativa, as invocações que usam o parâmetro de consulta continuam a ser suportadas.

Escopos delegados necessários

Para APIs de fluxos de dados, use estes tipos de escopo:

  • Escopo específico: Dataflow.Execute.All

Para obter mais informações sobre escopos, consulte: Escopos Artigo.

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identity Support
User Yes
Entidade de serviço e identidades geridas No

Interface

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

Parâmetros do URI

Name Em Necessário Tipo Description
dataflowId
 path True

string (uuid)

O ID do fluxo de dados.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Corpo do Pedido

Name Tipo Description
executionData

DataflowExecutionPayload

Carga útil para executar solicitação de tarefa de execução sob demanda. Necessário somente se o fluxo de dados tiver parametrização habilitada.

Respostas

Name Tipo Description
202 Accepted

Pedido aceite, a execução do trabalho está em curso.

Cabeçalhos

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

ErrorResponse

Códigos de erro comuns:

  • InsufficientPrivileges - O chamador não tem permissões suficientes para executar a instância de trabalho.

  • InvalidJobType - O tipo de trabalho solicitado é inválido.

  • TooManyRequestsForJobs - O chamador solicita muitas solicitações de trabalho sob demanda.

  • ItemNotFound - ID do item solicitado não encontrado.

Exemplos

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

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Pedido de amostra

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"
      }
    ]
  }
}

Resposta da amostra

Código de estado:
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

Definições

Name Description
DataflowExecutionPayload

A carga útil de dados de execução para o fluxo de dados
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ExecuteOption

Opções para executar a operação de execução. Opções de execução adicionais podem ser adicionadas ao longo do tempo.
ItemJobParameter

Detalhes dos parâmetros.
RunOnDemandDataflowExecuteJobRequest

Executar sob demanda executar carga útil da instância de trabalho de fluxo de dados
Type

O tipo de parâmetro. Tipos de parâmetros adicionais podem ser adicionados ao longo do tempo.

DataflowExecutionPayload

Object

A carga útil de dados de execução para o fluxo de dados

Name Tipo Description
executeOption

ExecuteOption

Opções para executar a operação de execução. Opções de execução adicionais podem ser adicionadas ao longo do tempo.
parameters

ItemJobParameter[]

Uma lista de parâmetros a serem substituídos durante a execução.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

ExecuteOption

Enumeração

Opções para executar a operação de execução. Opções de execução adicionais podem ser adicionadas ao longo do tempo.

Valor Description
SkipApplyChanges

Valor padrão. A operação Aplicar alterações é ignorada.
ApplyChangesIfNeeded

A operação Appply Changes é feita se necessário. Pode ser usado quando as alterações mais recentes são necessárias para Executar.

ItemJobParameter

Object

Detalhes dos parâmetros.

Name Tipo Description
parameterName

string

Nome do parâmetro.
type

Type

O tipo de parâmetro. Tipos de parâmetros adicionais podem ser adicionados ao longo do tempo.
value

O valor do parâmetro a ser substituído durante a execução.

RunOnDemandDataflowExecuteJobRequest

Object

Executar sob demanda executar carga útil da instância de trabalho de fluxo de dados

Name Tipo Description
executionData

DataflowExecutionPayload

Carga útil para executar solicitação de tarefa de execução sob demanda. Necessário somente se o fluxo de dados tiver parametrização habilitada.

Type

Enumeração

O tipo de parâmetro. Tipos de parâmetros adicionais podem ser adicionados ao longo do tempo.

Valor Description
Automatic

O valor deve ser automático