Partilhar via

Job Scheduler - Run On Demand Item Job

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

Executar instância de trabalho de item sob demanda.

Observaçã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 item, use estes tipos de escopo:

  • Escopo genérico: Item.Execute.All
  • Âmbito específico: itemType. Execute.All (por exemplo: Notebook.Execute.All)

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

Identidades suportadas pela Microsoft Entra

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

Identidade Apoio
Utilizador Sim
Entidade de serviço e identidades geridas Sim

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/instances

Parâmetros do URI

Name Em Necessário Tipo Description
itemId
 path True

string (uuid)

O ID do item.
jobType
 path True

string

Tipo de trabalho
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Corpo do Pedido

Name Tipo Description
executionData

object

Os dados de execução para um trabalho sob demanda. São dados estáticos fixos, definidos pelo tipo específico de trabalho do item.
parameters

Parameter[]

A lista de parâmetros para um trabalho sob demanda. São entradas definidas pelo utilizador por execução que adaptam esta invocação. Nota: Esta propriedade não é amplamente suportada. Se a API devolver um erro com erroCode FeatureNotAvailable e Mensagem Parameter is not allowed for this item type or this item job typede Erro , a parameters propriedade não é suportada para o tipo de item especificado ou para o tipo de trabalho de item.

Respostas

Name Tipo Description
202 Accepted

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

Cabeçalhos:

Localizaçãostring - A URL do recurso de instância de trabalho.

Re-Try Afterinteger - O número de segundos que o cliente deve esperar antes de consultar o estado do trabalho pela primeira vez. Os clientes devem usar este valor para determinar quando verificar o estado do trabalho e devem esperar pelo menos tantos segundos antes da primeira sondagem de estado.
429 Too Many Requests

ErrorResponse

O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais.

Cabeçalhos

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 item job instance with no request body example
Run item job instance with request body containing both executionData and parameters example
Run item job instance with request body containing executionData example
Run item job instance with request body containing parameters example

Run item job instance with no request body example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/DefaultJob/instances

Resposta da amostra

Código de estado:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Run item job instance with request body containing both executionData and parameters example

Pedido de amostra

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

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

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?jobType=Execute
Retry-After: 60

Run item job instance with request body containing executionData example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/DefaultJob/instances

{
  "executionData": {
    "tableName": "Table1",
    "optimizeSettings": {
      "vOrder": true
    }
  }
}

Resposta da amostra

Código de estado:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Run item job instance with request body containing parameters example

Pedido de amostra

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

{
  "parameters": [
    {
      "name": "param1",
      "value": "value1",
      "type": "Text"
    },
    {
      "name": "param2",
      "value": true,
      "type": "Boolean"
    },
    {
      "name": "param3",
      "value": 123,
      "type": "Number"
    }
  ]
}

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?jobType=Execute
Retry-After: 60

Definições

Name Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemJobParameterType

Uma cadeia que representa o tipo do parâmetro. Tipos adicionais podem ser adicionados ao longo do tempo.
Parameter

Um parâmetro de trabalho de item.
RunOnDemandItemJobRequest

Executar carga útil da instância de trabalho do item sob demanda

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 (uuid)

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.

ItemJobParameterType

Enumeração

Uma cadeia que representa o tipo do parâmetro. Tipos adicionais podem ser adicionados ao longo do tempo.

Valor Description
VariableReference

O tipo de parâmetro é uma referência variável.
Integer

O tipo de parâmetro é um inteiro.
Number

O tipo de parâmetro é um número, aceita tanto valores inteiros como flutuantes.
Text

O tipo de parâmetro é um texto.
Boolean

O tipo de parâmetro é booleano.
DateTime

O tipo de parâmetro é uma data-hora em UTC, usando o formato YYYY-MM-DDTHH:mm:ssZ.
Guid

O tipo de parâmetro é uma representação em cadeia de um GUID, usando o formato 00000000-0000-0000-0000000000. Consulte https://dotnet.territoriali.olinfo.it/dotnet/api/system.guid.tostring para detalhes de formatação e, por favor, use o formato padrão: "D".
Automatic

O tipo de parâmetro é automaticamente determinado. Nota: este tipo pode não ser suportado para todos os tipos de trabalhos de itens.

Parameter

Object

Um parâmetro de trabalho de item.

Name Tipo Description
name

string

O nome do parâmetro, especificado pelo chamador, deve ser único (verificação insensível a maiúsculas e minúsculas) e não ultrapassar 256 caracteres.
type

ItemJobParameterType

O tipo de parâmetro.
value

object

O valor do parâmetro baseado no tipo de parâmetro.

RunOnDemandItemJobRequest

Object

Executar carga útil da instância de trabalho do item sob demanda

Name Tipo Description
executionData

object

Os dados de execução para um trabalho sob demanda. São dados estáticos fixos, definidos pelo tipo específico de trabalho do item.
parameters

Parameter[]

A lista de parâmetros para um trabalho sob demanda. São entradas definidas pelo utilizador por execução que adaptam esta invocação. Nota: Esta propriedade não é amplamente suportada. Se a API devolver um erro com erroCode FeatureNotAvailable e Mensagem Parameter is not allowed for this item type or this item job typede Erro , a parameters propriedade não é suportada para o tipo de item especificado ou para o tipo de trabalho de item.