Compartilhar via

Job Scheduler - Run On Demand Item Job

  • Referência
Serviço:
Core
Versão da API:
v1

Execute a instância do trabalho de item sob demanda.

Escopos delegados necessários

Para APIs de item, use estes tipos de escopo:

  • Escopo genérico: Item.Execute.All
  • Escopo específico: itemType. Execute.All (por exemplo: Notebook.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.

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

Interfase

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
itemId
 path True

string (uuid)

A ID do item.
workspaceId
 path True

string (uuid)

O identificador do espaço de trabalho.
jobType
 query True

string

Tipo de trabalho

Corpo da solicitação

Nome Tipo Description
executionData

object

Conteúdo para executar solicitação de trabalho sob demanda. Necessário somente se o tipo de trabalho exigir uma carga.

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

Run item job instance with no request body example

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

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

Resposta de exemplo

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

Definições

Nome Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
RunOnDemandItemJobRequest

Conteúdo da instância do trabalho do item executar sob demanda

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.

RunOnDemandItemJobRequest

Objeto

Conteúdo da instância do trabalho do item executar sob demanda

Nome Tipo Description
executionData

object

Conteúdo para executar solicitação de trabalho sob demanda. Necessário somente se o tipo de trabalho exigir uma carga.