Compartilhar via

Background Jobs - Run On Demand Execute

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

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

Note

Essa API faz parte de uma versão prévia e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção. A URL dessa API foi atualizada para incluir o tipo de trabalho como parte do caminho, substituindo o uso anterior de um parâmetro de consulta. Para compatibilidade com versões anteriores, ainda há suporte para invocações usando o parâmetro de consulta.

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: artigo de escopos.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

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

Interface

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
dataflowId
 path True

string (uuid)

A ID do fluxo de dados.
workspaceId
 path True

string (uuid)

O identificador do espaço de trabalho.

Corpo da solicitação

Nome Tipo Description
executionData

DataflowExecutionPayload

Conteúdo para executar solicitação de trabalho executada sob demanda. Necessário somente se o fluxo de dados tiver a parametrização habilitada.

Respostas

Nome Tipo Description
202 Accepted

Solicitação aceita, execução do trabalho está em andamento.

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

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

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

  • ItemNotFound – ID do item solicitada não encontrada.

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

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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 de exemplo

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

Nome Description
DataflowExecutionPayload

A carga 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. ExecuteOptions adicionais podem ser adicionadas ao longo do tempo.
ItemJobParameter

Detalhes do parâmetro.
RunOnDemandDataflowExecuteJobRequest

Executar sob demanda executar o conteúdo da instância de trabalho de fluxo de dados
Type

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

DataflowExecutionPayload

Objeto

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

Nome Tipo Description
executeOption

ExecuteOption

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

ItemJobParameter[]

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

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

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

string

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

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

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

string

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

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

ExecuteOption

Enumeração

Opções para executar a operação de execução. ExecuteOptions 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 Alterações appply é feita se necessário. Pode ser usado quando as alterações mais recentes são necessárias para Executar.

ItemJobParameter

Objeto

Detalhes do parâmetro.

Nome Tipo Description
parameterName

string

Nome do parâmetro.
type

Type

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

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

RunOnDemandDataflowExecuteJobRequest

Objeto

Executar sob demanda executar o conteúdo da instância de trabalho de fluxo de dados

Nome Tipo Description
executionData

DataflowExecutionPayload

Conteúdo para executar solicitação de trabalho executada sob demanda. Necessário somente se o fluxo de dados tiver a parametrização habilitada.

Type

Enumeração

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

Valor Description
Automatic

O valor deve ser Automático