Job Scheduler - Cancel Item Job Instance

Serviço:

Core

Versão da API:

v1

Cancele a instância de trabalho de um item.

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/{jobInstanceId}/cancel

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
itemId	path	True	string (uuid)	A ID do item.
jobInstanceId	path	True	string (uuid)	A ID da instância do trabalho.
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação aceita, o cancelamento de um 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 cancelar a instância do trabalho. ItemNotFound – ID do item solicitado não encontrada. JobAlreadyCompleted – O cancelamento solicitado não pode ser processado à medida que a execução da instância de trabalho for concluída.

Exemplos

Cancel item job instance example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/instances/5b218778-e7a5-4d73-8187-f10824047715/cancel

Resposta de exemplo

Código de status:

202

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/instances/5b218778-e7a5-4d73-8187-f10824047715
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.

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.