Job Scheduler - Cancel Item Job Instance

Service:

Core

Version d'API:

v1

Annulez l’instance de travail d’un élément.

Étendues déléguées requises

Pour les API d’élément, utilisez ces types d’étendue :

• Étendue générique : Item.Execute.All
• Étendue spécifique : itemType. Execute.All (par exemple : Notebook.Execute.All)

pour plus d’informations sur les étendues, consultez article sur les étendues.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
itemId	path	True	string (uuid)	ID d’élément.
jobInstanceId	path	True	string (uuid)	ID de l’instance de travail.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.

Réponses

Nom	Type	Description
202 Accepted		La demande acceptée, l’annulation d’un travail est en cours. En-têtes Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : InsufficientPrivileges : l’appelant ne dispose pas des autorisations suffisantes pour annuler l’instance de travail. ItemNotFound - ID d’élément demandé introuvable. JobAlreadyCompleted : l’annulation demandée ne peut pas être traitée à mesure que l’exécution de l’instance de travail est terminée.

Exemples

Cancel item job instance example

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.