Long Running Operations - Get Operation State

Service:: Core

Version d'API:: v1

Retourne l’état actuel de l’opération de longue durée.
Vous obtenez l’operationId à partir de l’en-tête x-ms-operation-id retourné par l’API qui a lancé l’opération. Une fois que l’état de l’opération est « Réussi », utilisez l’API Get Operation Result pour récupérer le résultat.

Autorisations

Identique aux autorisations requises pour l’API qui a lancé l’opération.

Étendue déléguée requise

Identique aux étendues requises pour l’API qui a lancé l’opération.

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

GET https://api.fabric.microsoft.com/v1/operations/{operationId}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
operationId	path	True	string (uuid)	ID d’opération

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK	OperationState	La demande s’est terminée avec succès. En-têtes Location: string Retry-After: integer x-ms-operation-id: string
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : UnknownError : une erreur s’est produite.

OperationState

La demande s’est terminée avec succès.

En-têtes

Location: string
Retry-After: integer
x-ms-operation-id: string

429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

UnknownError : une erreur s’est produite.

Exemples

Get active long running operation example

Get completed long running operation example

Get active long running operation example

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Exemple de réponse

Code d’état:: 200

Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227
Retry-After: 20

{
  "status": "Running",
  "createdTimeUtc": "2023-09-13T14:56:18.477Z",
  "lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
  "percentComplete": 25
}

Get completed long running operation example

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227

Exemple de réponse

Code d’état:: 200

Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227/result
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227

{
  "status": "Succeeded",
  "createdTimeUtc": "2023-09-13T14:56:18.477Z",
  "lastUpdatedTimeUtc": "2023-09-13T15:01:10.532Z",
  "percentComplete": 100
}

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.
LongRunningOperationStatus	État actuel de l’opération. Des états d’opération supplémentaires peuvent être ajoutés au fil du temps.
OperationState	Objet décrivant les détails et l’état actuel d’une opération longue

ErrorRelatedResource

Objet

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

Objet

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.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
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 (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

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.

LongRunningOperationStatus

Énumération

État actuel de l’opération. Des états d’opération supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Undefined	L’état de l’opération n’est pas défini
NotStarted	L’opération n’a pas démarré
Running	L’opération est en cours d’exécution
Succeeded	L’opération s’est terminée avec succès
Failed	L’opération a échoué

OperationState

Objet

Objet décrivant les détails et l’état actuel d’une opération longue

Nom	Type	Description
createdTimeUtc	string (date-time)	Date et heure de début de l’opération
error	ErrorResponse	Détails de l’erreur en cas d’échec de l’opération
lastUpdatedTimeUtc	string (date-time)	Date et heure de la dernière modification de l’opération
percentComplete	integer (int32) minimum: 0 maximum: 100	Progression de l’opération en pourcentage
status	LongRunningOperationStatus	État actuel de l’opération. Des états d’opération supplémentaires peuvent être ajoutés au fil du temps.